...
Get-JobSchedulerOrderHistory
SYNOPSIS
ReturnsJobScheduler history items Returns a number of JobScheduler history entries for orders.
SYNTAX
Get-JobSchedulerOrderHistory [[-OrderIdDirectory] <String>] [ [-JobChain] <String> ] [[-DirectoryOrder] <String>] [[-RecursiveMaxHistoryEntries] [-Compact<Int32>] [-WithLog] [ [-MaxLastHistoryItems] <Int32>] [<CommonParameters>]
DESCRIPTION
...
offers the same functionality when used with the -WithHistory switch. Therefore the
same functionality applies to both cmdlets.
Order history items 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 is assigned.
* by a specific an individual order.
Resulting orders can be forwarded to other cmdlets for pipelined bulk operations.
PARAMETERS
...
Directory
-OrderId Directory <String>
Optionally specifies the path and name of an order folder for which the history orders should be returned. The directory is determined
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 orderfrom the root folder, i.e. the "live" directory.
| Required? | false |
| Position? | 1 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-JobChain <String>
Specifies the path and name of a job chain for which order history items 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? | falsetrue |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
Order
-Directory Order <String>
Optionally specifies the folder for which order history items path and name of an order that should be returned. The directory is determined
from the root folder, i.e. the "live" directory
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
-Recursive <SwitchParameter>MaxHistoryEntries <Int32>
Specifies that any sub-folders should be looked up if the -Directory parameter is used.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Compact
-Compact <SwitchParameter>
Specifies that fewer order history attributes will be returned. 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? | named4 |
| Default value | False1 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
MaxLastHistoryItems
...
| Required? | false |
| Position? | 4 |
| Default value | 1 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
Returns the latest history item entry for job chain "chain1" from the folder "/test/globals".
...
PS > $history = Get-JobSchedulerOrderHistory -JobChain /test/globals/chain1 -OrderId Order order1
Returns the latest history item for entry order "order1" from the folder "/test/globals" with the job chain "chain1".
...
PS > $history = Get-JobSchedulerOrderHistory -JobChain /test/globals/chain1 -MaxLastHistoryItems MaxHistoryEntries 5
Returns the 5 latest history items entries for the specified job chain and includes the log output.
...
PS > $history = Get-JobSchedulerOrderHistory -JobChain /test/globals/chain1 -WithLog
Returns the 5 latest history item entries for the specified job chain and includes the log output.