Name
Get-JobSchedulerOrderHistory
SYNOPSIS
Returns a number of JobScheduler history entries for orders.
SYNTAX
Get-JobSchedulerOrderHistory [[-Directory] <String>] [-JobChain] <String> [[-Order] <String>] [[-MaxHistoryEntries] <Int32>] [-WithLog] [<CommonParameters>]
DESCRIPTION
Order history entries 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 is assigned to an order
* by an individual order.
Resulting orders can be forwarded to other cmdlets for pipelined bulk operations.
PARAMETERS
Directory
-Directory <String>
Optionally specifies the folder for which orders should be returned. The directory is determined
from the root folder, i.e. the "live" directory.
| Required? | false |
| Position? | 1 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
JobChain
-JobChain <String>
Specifies the path and name of a job chain for which orders should be 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.
| Required? | true |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Order
-Order <String>
Optionally specifies the path and name of an order that should be returned.
If the name of an order is specified then the -Directory parameter is used to determine the folder.
Otherwise the -Order parameter is assumed to include the full path and name of the order.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
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 | 1 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
WithLog
-WithLog <SwitchParameter>
Specifies the order log to be returned.
This operation is time-consuming and should be restricted to selecting individual orders.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $history = Get-JobSchedulerOrderHistory -JobChain /test/globals/chain1
Returns the latest history entry for job chain "chain1" from the folder "/test/globals".
-------------------------- EXAMPLE 2 --------------------------
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 --------------------------
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 --------------------------
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.