Name
Get-JobSchedulerOrderHistory
SYNOPSIS
ReturnsJobScheduler history items for orders.
SYNTAX
Get-JobSchedulerOrderHistory [[-OrderId] <String>] [[-JobChain] <String>] [[-Directory] <String>] [-Recursive] [-Compact] [-WithLog] [[-MaxLastHistoryItems] <Int32>] [<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 operations.
PARAMETERS
OrderId
-OrderId <String>
Optionally specifies the path and name 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.
| 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 order history items 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? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Directory
-Directory <String>
Optionally specifies the folder for which order history items should be returned. The directory is determined
from the root folder, i.e. the "live" directory.
| Required? | false |
| Position? | 3 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Recursive
-Recursive <SwitchParameter>
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.
| Required? | false |
| Position? | named |
| Default value | False |
| 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 |
MaxLastHistoryItems
-MaxLastHistoryItems <Int32>
Specifies the number of items that should be returned from the history. Items 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 |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $history = Get-JobSchedulerOrderHistory -JobChain /test/globals/chain1
Returns the latest history item for job chain "chain1" from the folder "/test/globals".
-------------------------- EXAMPLE 2 --------------------------
PS > $history = Get-JobSchedulerOrderHistory -JobChain /test/globals/chain1 -OrderId order1
Returns the latest history item for order "order1" from the folder "/test/globals" with the job chain "chain1".
-------------------------- EXAMPLE 3 --------------------------
PS > $history = Get-JobSchedulerOrderHistory -JobChain /test/globals/chain1 -MaxLastHistoryItems 5
Returns the 5 latest history items for the specified job chain and includes the log output.
-------------------------- EXAMPLE 4 --------------------------
PS > $history = Get-JobSchedulerOrderHistory -JobChain /test/globals/chain1 -WithLog
Returns the latest history item for the specified job chain and includes the log output.