NAME
Get-JobSchedulerOrder
SYNOPSIS
Returns a number of orders from the JobScheduler Master.
SYNTAX
Get-JobSchedulerOrder [-Directory <String>] [-JobChain <String>] [-Order <String>] -NoSubfolders -NoPermanent
-Suspended -Setback <CommonParameters>
DESCRIPTION
Orders are selected from a JobScheduler Master
- by the folder of the order location including subfolders
- 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.
One of the parameters -Directory, -JobChain or -Order has to be specified if no pipelined order objects are provide
d.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
JobChain
-JobChain <String>
Optionally 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.
One of the parameters -Directory, -JobChain or -Order has to be specified if no pipelined order objects are provide
d.
Required? false
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.
One of the parameters -Directory, -JobChain or -Order has to be specified if no pipelined order objects are provide
d.
Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
NoSubfolders
-NoSubfolders <SwitchParameter>
Specifies that no subfolders should be looked up. By default any subfolders will be searched for orders.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?
NoPermanent
-NoPermanent <SwitchParameter>
Specifies that no permanent orders should be looked up but instead ad hoc orders only.
By default only permanent orders will be looked up.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?
Suspended
-Suspended <SwitchParameter>
Specifies that only suspended orders should be returned.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?
Setback
-Setback <SwitchParameter>
Specifies that only setback orders should be returned.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?
RELATED LINKS
about_jobscheduler
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
C:\PS>$orders = Get-Order
Returns all orders.
-------------------------- EXAMPLE 2 --------------------------
C:\PS>$orders = Get-Order -Directory / -NoSubfolders
Returns all orders that are configured with the root folder ("live" directory)
without consideration of subfolders.
-------------------------- EXAMPLE 3 --------------------------
C:\PS>$orders = Get-Order -JobChain /test/globals/chain1
Returns the orders for job chain chain1 from the folder "/test/globals".
-------------------------- EXAMPLE 4 --------------------------
C:\PS>$orders = Get-Order -Order /test/globals/order1
Returns the order order1 from the folder "/test/globals".