Page History

Name

Get-JobSchedulerOrderHistory

SYNOPSIS

ReturnsJobScheduler Returns the order execution history items for ordersjob chains.

SYNTAX

Get-JobSchedulerOrderHistory [[-OrderId] <String>] [[-JobChain] <String>] [[-Directory] <String>] [-Recursive] [[-ExcludeOrder] <String[]>] [[-RegEx] <String>] [[-DateFrom] <DateTime>] [-Compact[-DateTo] <DateTime>] [[-RelativeDateFrom] <String>] [[-RelativeDateTo] <String>] [[-WithLogTimezone] <TimeZoneInfo>] [[-MaxLastHistoryItemsLimit] <Int32>] [-Successful] [-Failed] [-Incomplete] [<CommonParameters>]

DESCRIPTION

This cmdlet is deprecated as it is an alias for the Get-JobSchedulerOrder cmdlet that
offers the same functionality when used with the -WithHistory switch. Therefore the
same functionality applies to both cmdlets.
Order history items are returned independently from the fact that the order is present in the JobScheduler Master.
This includes temporary ad hoc orders to be returned that are completed and not active
with a Master.
Orders are selected from a JobScheduler Master
* by the job chain that an order is assigned.
* by a specific order.
Resulting orders can be forwarded to other cmdlets for pipelined bulk operationsHistory information is returned for orders from a JobScheduler Master.
Order executions can be selected by job chain, order ID, folder, history status etc.

The history information retured includes start time, end time, return code etc.

PARAMETERS

OrderId

-OrderId <String>
Optionally specifies the path and name identifier of an order for which the history should be returned.
If the ID of an order is specified then the -Directory parameter is used to determine the folder.
Otherwise the -OrderId parameter is assumed to include the full path and ID of the order.order to limit results to that order.
This parameter requires use of the -JobChain parameter.

JobChain

-JobChain <String>
Specifies Optionally specifies the path and name of a job chain for which order history items should be information is returned.
If the name of a job chain is specified then the -Directory parameter is used to determine the folder.
Otherwise the -JobChain parameter is assumed to include the full path and name of the job chain.

One of the parameters -Directory or -JobChain has to be specified.

Directory

-Directory <String>
Optionally specifies the folder for which order history items jobs should be returned. The directory is determined
from the root folder, i.e. the "live" directory.

Recursive

-Recursive <SwitchParameter>
Specifies that any sub-folders should be looked up if when used with the -Directory parameter is used.
By default no sub-folders will be looked up for jobs.

ExcludeOrder

-ExcludeOrder <String[]>
This parameter accepts a single job chain path or an array of job chain paths that are excluded from the results.
Optionally the job chain path can be appended an order ID separated by a semicolon.

...

RegEx

-Compact <SwitchParameter>RegEx <String>
Specifies that fewer order history attributes will be returned.a regular expression that filters the orders to be returned.
The regular expression is applied to the path and ID of orders.

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

-WithLog <SwitchParameter>DateTo <DateTime>
Specifies the order log to be returned.
This operation is time-consuming and should be restricted to selecting individual ordersdate 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-JSOrderHistory -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-JSOrderHistory -Timezone (Get-Timezone)

Default: Dates are returned in UTC.

...

Limit

-MaxLastHistoryItems Limit <Int32>
Specifies the max. number of items that should be returned from the history. Items are provided
in descending order starting with the latest history entry.
Default: 1history items for order executions to be returned.
The default value is 10000, for an unlimited number of items the value -1 can be specified.

Successful

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

Failed

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

Incomplete

-Incomplete <SwitchParameter>
Specifies that history information for running orders should be returned.

RELATED LINKS

about_jobschedulerJobScheduler

EXAMPLES

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

PS > $items = Get-JobSchedulerOrderHistory

Returns today's order execution history for any orders.

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

PS > $items = Get-JobSchedulerOrderHistory -RegEx '^/sos'

Returns today's order execution history for any orders from the /sos folder.

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

PS > $items = Get-JobSchedulerOrderHistory -RegEx 'report'

Returns today's order execution history for orders that contain the string 'report' in the order's path.

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

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

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

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

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

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

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

PS > $items PS > $history = Get-JobSchedulerOrderHistory -JobChain /testsos/globalsdailyplan/chain1CreateDailyPlan

Returns the latest history item for job chain "chain1" from the folder "/test/globals".today's order execution history for a given job chain.

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

PS > $items = Get-JobSchedulerOrderHistory -ExcludeOrder /sos/dailyplan/CreateDailyPlan, /sos/notification/SystemNotifier:MonitorSystem

Returns today's order execution history for any orders excluding orders from the specified job chain paths. The job chain path '/sos/notification/SystemNotifier' is appended the order ID 'MonitorSystem' separated by a semicolon to indicate that the specified order ID only is excluded from the results.

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

PS > $items = Get-JobSchedulerOrderHistory -Successful -DateFrom "2020-08-11 14:00:00Z"

Returns the order execution history for successfully completed orders that started after the specified UTC date and time.

-------------------------- EXAMPLE 9 --------------------------

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

Returns the order execution history for any failed orders for the last seven days.

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

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

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

-------------------------- EXAMPLE 11 2 --------------------------

PS > $history $items = Get-JobSchedulerOrderHistory -JobChain /test/globals/chain1 -OrderId order1RelativeDateFrom -7d+01:00

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

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

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

Returns the order execution history for the last seven days. The history is reported starting from midnight in the same timezone that is used with the -Timezone parameter item for order "order1" from the folder "/test/globals" with the job chain "chain1".

-------------------------- EXAMPLE 3 13 --------------------------

PS > $history $items = Get-JobSchedulerOrderHistory -JobChain /test/globals/chain1 -MaxLastHistoryItems 5RelativeDateFrom -1w

Returns the 5 latest history items for the specified job chain and includes the log outputorder execution history for any jobs for the last week.

-------------------------- EXAMPLE 4 14 --------------------------

PS > $history $items = Get-JobSchedulerOrderHistory -JobChain /test/globals/chain1 -WithLogDirectory /sos -Recursive -Successful -Failed

Returns today's order execution history for any completed orders from the "/sos" directory and any sub-folders recursivelyReturns the latest history item for the specified job chain and includes the log output.