Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

SYNOPSIS

Returns a number of orders from the JobScheduler history entries for orders.

SYNTAX

Get-JobSchedulerOrderHistory [-Directory <String>] -JobChain <String> [-Order <String>] [-WithLog [<CommonParame
ters>]MaxHistoryEntries <In
t32>] -WithLog <CommonParameters>

DESCRIPTION

Orders Order history entries are returned independently from the fact if they are 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.

...

Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

MaxHistoryEntries

-MaxHistoryEntries <Int32>
Specifies the number of entries that are returned from the history. Entries are provided
in descending order starting with the latest history entry.

Default: 1

Required? false
Position? 4
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

WithLog

-WithLog <SwitchParameter>
Specifies the order log to be returned.

...

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

C:\PS>$orders PS>$history = Get-JobSchedulerOrderHistory -JobChain /test/globals/chain1

Returns the orders latest history entry for job chain "chain1" from the folder "/test/globals".

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

C:\PS>$orders PS>$history = Get-JobSchedulerOrderHistory -JobChain /test/globals/chain1 -Order order1

Returns the latest history entry order "order1" from the folder "/test/globals" with the job chain "chain1".

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

C:\PS>$history = Get-JobSchedulerOrderHistory -JobChain /test/globals/chain1 -MaxHistoryEntries 5

Returns the 5 latest history entries for the specified job chain and includes the log output.

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

C:\PS>$history = Get-JobSchedulerOrderHistory -JobChain /test/globals/chain1 -WithLog

Returns the 5 latest history entries for the specified job chain and includes the log output.