Page History
...
Returns the task execution history for jobs.
SYNTAX
Get-JS7TaskHistory [[-Job] <String>] [[-WorkflowWorkflowPath] <String>] [[-OrderId] <String>] [[-Directory] Folder] <String>] [-Recursive] [[-State] <String>] [[-ExcludeJob] <String[]><Hashtable>] [[-RegExJobName] <String>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-Timezone] <TimeZoneInfo>] [[-TaskId] <Int32>] <Int32[[-Limit] ><Int32>] [-NormalCriticality] [-LimitMinorCriticality] <Int32>[-MajorCriticality] [-Successful] [-Failed] [-IncompleteInProgress] [<CommonParameters>]
DESCRIPTION
History information is returned for jobs from a JobScheduler 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.
PARAMETERS
The following REST Web Service API resources are used:
* /tasks/history
PARAMETERS
JobJob
-Job <String>
Optionally specifies the path and name of a job for which task execution results are reported.
If the name of a job is specified then
This parameter requires use of the -Directory WorkflowPath parameter is used to determine the folder.
Otherwise the -Job parameter is assumed to include the full path and name of the job.
One of the parameters -Directory, -Workflow or -Job has to be specified. to specify the workflow
that includes the job.
| Required?Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
WorkflowPath
-Workflow WorkflowPath <String>
Optionally specifies the path and name of a workflow that includes jobs.
If the name of a workflow is specified then the -Directory parameter is used to determine the folder.
Otherwise the -Workflow parameter is assumed to include the full path and name of the workflow.
One of the parameters -Directory, -Workflow or -Job has to be specifiedfor which the task history is reported. The task execution history optionally can futher
be limited by specifying the -Job parameter to limit results to a job in the given workflow.
| 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
correspond to the order's current statefolder that includes workflows for which the task history should be returned.
| Required? | false |
| Position? | 3 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
Recursive
-Directory <String>
Optionally specifies the folder for which jobs should be returned. The directory is determined
from the root folder, i.e. the "live" directoryRecursive <SwitchParameter>
Specifies that any sub-folders should be looked up when used with the -Folder parameter.
By default no sub-folders will be looked up for jobs.
| Required? | false |
| Position? | 4named |
| Default value | /False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
ExcludeJob
-Recursive <SwitchParameter>
Specifies that any sub-folders should be looked up when used with the -Directory parameter.
By default no sub-folders will be looked up for jobsExcludeJob <Hashtable>
This parameter accepts a hashmap of job names and optionally workflow paths that are excluded from results.
If a workflow path is specified then all jobs of the given workflow are excluded.
| Required? | false |
| Position? | named4 |
| Default valueFalse | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
JobName
-State JobName <String>
Specifies that only jobs are considered that an order is currently passing. This is identified by the
order's state attribute that corresponds to the job node's state attribute.
This parameter requires use of the -Workflow parameter. If used with the -OrderId parameter then
only jobs for that order are considered, otherwise jobs for any orders in the given workflow are considered. the name of a job that is looked up by use of * and ? wildcard characters:
* : match zero or more characters
? : match any single character
| Required? | false |
| Position? | 5 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
DateFrom
-ExcludeJob <String[]>
This parameter accepts a single job path or an array of job paths that are excluded from the results. DateFrom <DateTime>
Specifies the date starting from which history items should be returned.
Consider that a UTC date has to be provided.
Default: Beginning of the current day as a UTC date
| Required? | false |
| Position? | 6 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| (Get-Date -Hour 0 -Minute 0 -Second 0).ToUniversalTime() | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept Accept wildcard characters? | false |
...
DateTo
-RegEx <String>DateTo <DateTime>
Specifies a regular expression that filters the jobs to the date until which history items should be returned.
The regular expression is applied to the path and name of jobs. Consider that a UTC date has to be provided.
Default: End of the current day as a UTC date
| Required? | false |
| Position? | 7 |
| Default value | (Get-Date -Hour 0 -Minute 0 -Second 0).AddDays(1).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
RelativeDateFrom
-DateFrom <DateTime>RelativeDateFrom <String>
Specifies the a relative date starting from which history items should be returned, e.
Consider that a UTC date has to be provided.
Default: Begin of the current day as a UTC date
| Required? | false |
| Position? | 8 |
| Default value | (Get-Date -Hour 0 -Minute 0 -Second 0).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
DateTo
...
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. 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? | 8 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Required? | false |
| Position? | 9 |
| Default value | (Get-Date -Hour 0 -Minute 0 -Second 0).AddDays(1).ToUniversalTime() |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
RelativeDateTo
-RelativeDateFrom RelativeDateTo <String>
Specifies a relative date starting from 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? | 109 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
Timezone
-RelativeDateTo <String>Timezone <TimeZoneInfo>
Specifies a relative date until which history items should be returned, the timezone to which dates should be converted in the history information.
A timezone can 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 is calculated by the cmdlet
for the timezone that is specified with the -Timezone parameter.
This parameter takes precedence over the -DateFrom parameter. be specified like this:
Get-JSTaskHistory -Timezone (Get-Timezone -Id 'GMT Standard Time')
All dates in 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? | 10 |
| Default value | (Get-Timezone -Id 'UTC') |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
TaskId
-TaskId <Int32>
Specifies that the execution history should only be reported for the given task ID.
| Required? | false | |
| Position? | 11 | |
| Default value | 0 | |
| Required? | false | |
| Position? | 11 | |
| Default value | Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
Limit
-Timezone <TimeZoneInfo>Limit <Int32>
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. 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? | 12 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
NormalCriticality
-NormalCriticality <SwitchParameter>
Specifies that the task history should only be returned for jobs that are assigned a "normal" criticality.
| Required? | false |
| Position? | named |
| Default value | False |
| Required? | false |
| Position? | 12 |
| Default value | (Get-Timezone -Id 'UTC') |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
MinorCriticality
-TaskId <Int32[]>MinorCriticality <SwitchParameter>
Specifies that the task history should only be returned for jobs that are assigned a "minor" criticality.
| Required? | false |
| Position? | 13named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
MajorCriticality
-Limit <Int32>MajorCriticality <SwitchParameter>
Specifies that 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. task history should only be returned for jobs that are assigned a "major" criticality.
| RequiredRequired? | false |
| Position? | 14named |
| Default value | 0False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
InProgress
-Incomplete InProgress <SwitchParameter>
Specifies that history information for running tasks should be returned.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $items = Get-JS7TaskHistory
...
| false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 2 1 --------------------------
PS > $items = Get-JS7TaskHistory -RegEx '^/sos'
Returns today's task execution history for any jobs from the /sos folder.
-------------------------- EXAMPLE 3 2 --------------------------
PS > $items = Get-JS7TaskHistory -RegEx 'report'JobName "*sos*"
Returns today's task execution history for all jobs that contain the string 'report' in the job pathwith a job name that includes "sos".
-------------------------- EXAMPLE 4 3 --------------------------
...
Returns today's task execution history for any all jobs with dates being converted to the local timezone.
-------------------------- EXAMPLE 5 4 --------------------------
...
Returns today's task execution history for any all jobs with dates being converted to the GMT timezone.
-------------------------- EXAMPLE 6 5 --------------------------
...
-------------------------- EXAMPLE 7 6 --------------------------
PS > $items = Get-JS7TaskHistory -Workflow WorkflowPath /sos/dailyplan/CreateDailyPlansome_path/some_workflow
Returns today's task execution history for jobs in the given workflow.
-------------------------- EXAMPLE 8 7 --------------------------
PS > $items = Get-JS7TaskHistory -ExcludeJob /sos/dailyplan/CreateDailyPlan, /sos/housekeeping/scheduler_rotate_log@{ 'workflowPath'='/some_path/some_workflow'; 'job'='some_job' }
Returns today's task execution history for any all jobs excluding the specified workflow paths and job pathsnames.
-------------------------- EXAMPLE 9 8 --------------------------
...
-------------------------- EXAMPLE 10 9 --------------------------
...
Returns the task execution history for any all failed jobs for the last seven days.
-------------------------- EXAMPLE 11 10 --------------------------
...
-------------------------- EXAMPLE 12 11 --------------------------
...
-------------------------- EXAMPLE 13 12 --------------------------
...
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.
-------------------------- EXAMPLE 14 13 --------------------------
...
-------------------------- EXAMPLE 15 14 --------------------------
PS > $items = Get-JS7TaskHistory -Directory Folder /sos -Recursive -Successful -Failed
Returns today's task execution history for any all completed tasks from the "/sos" directory folder and any sub-folders recursively.
Overview
Content Tools