PowerShell CLI 2.0 - Cmdlets - Get-JS7TaskHistory

Name

Get-JS7TaskHistory

SYNOPSIS

Returns the task execution history for jobs

SYNTAX

Get-JS7TaskHistory [[-Job] <String>] [[-WorkflowPath] <String>] [[-OrderId] <String>] [[-Position] <String>] [[-Folder] <String>] [-Recursive] [[-ExcludeJob] <Hashtable>] [[-RegularExpression] <String>] [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-Timezone] <TimeZoneInfo>] [[-TaskId] <Int32>] [[-Limit] <Int32>] [-NormalCriticality] [-MinorCriticality] [-MajorCriticality] [-Successful] [-Failed] [-InProgress] [<CommonParameters>]

DESCRIPTION

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.

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.

WorkflowPath

-WorkflowPath <String>
Optionally specifies the path and name of a workflow that includes jobs
for 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.

OrderId

-OrderId <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 history should be returned.

Recursive

-Recursive <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.

ExcludeJob

-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.

RegularExpression

-RegularExpression <String>
Specifies a regular expression that filters the jobs to be returned.
The regular expression is applied to the job name.

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

DateTo

-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

RelativeDateFrom

-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 is calculated by the cmdlet
for the timezone that is specified with the -Timezone parameter.

This parameter takes precedence over the -DateFrom parameter.

RelativeDateTo

-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 is calculated by the cmdlet
for the timezone that is specified with the -Timezone parameter.

This parameter takes precedence over the -DateFrom parameter.

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.

TaskId

-TaskId <Int32>
Specifies to report the execution history for the given task ID only.

Limit

-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.

NormalCriticality

-NormalCriticality <SwitchParameter>
Specifies to return the task history for jobs only that are assigned a "normal" criticality.

MinorCriticality

-MinorCriticality <SwitchParameter>
Specifies to return the task history for jobs only that are assigned a "minor" criticality.

MajorCriticality

-MajorCriticality <SwitchParameter>
Specifies to return the task history for jobs only that are assigned a "major" criticality.

Successful

-Successful <SwitchParameter>
Returns history information for successfully completed tasks.

Failed

-Failed <SwitchParameter>
Returns history information for failed tasks.

InProgress

-InProgress <SwitchParameter>
Specifies that history information for running tasks should be returned.

RELATED LINKS

about_JS7

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

PS > $items = Get-JS7TaskHistory

Returns today's task execution history for any jobs.

-------------------------- EXAMPLE 2 --------------------------

PS > $items = Get-JS7TaskHistory -RegularExpression "sos$"

Returns today's task execution history for any jobs with a job name that ends with "sos".

-------------------------- EXAMPLE 3 --------------------------

PS > $items = Get-JS7TaskHistory -Timezone (Get-Timezone)

Returns today's task execution history for any jobs with dates being converted to the local timezone.

-------------------------- EXAMPLE 4 --------------------------

PS > $items = Get-JS7TaskHistory -Timezone (Get-Timezone -Id 'GMT Standard Time')

Returns today's task execution history for any jobs with dates being converted to the GMT timezone.

-------------------------- EXAMPLE 5 --------------------------

PS > $items = Get-JS7TaskHistory -Job /sos/dailyplan/CreateDailyPlan

Returns today's task execution history for a given job.

-------------------------- EXAMPLE 6 --------------------------

PS > $items = Get-JS7TaskHistory -WorkflowPath /some_path/some_workflow

Returns today's task execution history for jobs in the given workflow.

-------------------------- EXAMPLE 7 --------------------------

PS > $items = Get-JS7TaskHistory -ExcludeJob @{ 'workflowPath'='/some_path/some_workflow'; 'job'='some_job' }

Returns today's task execution history for any jobs excluding the specified workflow paths and job names.

-------------------------- EXAMPLE 8 --------------------------

PS > $items = Get-JS7TaskHistory -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 9 --------------------------

PS > $items = Get-JS7TaskHistory -Failed -DateFrom (Get-Date -Hour 0 -Minute 0 -Second 0).AddDays(-7).ToUniversalTime()

Returns the task execution history for any failed jobs for the last seven days.

-------------------------- EXAMPLE 10 --------------------------

PS > $items = Get-JS7TaskHistory -RelativeDateFrom -7d

Returns the task execution history for the last seven days. The history is reported starting from midnight UTC.

-------------------------- EXAMPLE 11 --------------------------

PS > $items = Get-JS7TaskHistory -RelativeDateFrom -7d+01:00

Returns the task execution history for the last seven days. The history is reported starting from 1 hour after midnight UTC.

-------------------------- EXAMPLE 12 --------------------------

PS > $items = Get-JS7TaskHistory -RelativeDateFrom -7d+TZ

Returns the task execution history for any 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 13 --------------------------

PS > $items = Get-JS7TaskHistory -RelativeDateFrom -1w

Returns the task execution history for the last week.

-------------------------- EXAMPLE 14 --------------------------

PS > $items = Get-JS7TaskHistory -Folder /sos -Recursive -Successful -Failed

Returns today's task execution history for any completed tasks from the "/sos" directory and any sub-folders recursively.