NAME
Get-JobSchedulerOrderHistory
SYNOPSIS
Returns a number of orders from the JobScheduler history.
SYNTAX
Get-JobSchedulerOrderHistory [-Directory <String>] -JobChain <String> [-Order <String>] -WithLog [<CommonParame
ters>]
DESCRIPTION
Orders are returned independently from the fact if they are 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?
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?
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?
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
Accept pipeline input? false
Accept wildcard characters?
RELATED LINKS
about_jobscheduler
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
C:\PS>$orders = Get-JobSchedulerOrderHistory -JobChain /test/globals/chain1
Returns the orders for job chain "chain1" from the folder "/test/globals".
-------------------------- EXAMPLE 2 --------------------------
C:\PS>$orders = Get-JobSchedulerOrderHistory -JobChain /test/globals/chain1 -Order order1
Returns the order "order1" from the folder "/test/globals" with the job chain "chain1".