NAME
Add-JobSchedulerOrder
SYNOPSIS
Adds an order to a job chain in the JobScheduler Master.
SYNTAX
Add-JobSchedulerOrder -JobChain <String> [-Order <String>] [-Parameters <Hashtable>] [-Title <String>] [-At <
String>] [-State <String>] [-EndState <String>] -Replace -Immediate <CommonParameters>
DESCRIPTION
Creates a temporary ad hoc order for execution with the specified job chain
PARAMETERS
JobChain
-JobChain <String>
Specifies the path and name of a job chain for which orders should be added.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters?
Order
-Order <String>
Optionally specifies the identifier of an order.
Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
Parameters
-Parameters <Hashtable>
Specifies the parameters for the order. Parameters are created from a hashmap,
i.e. a list of names and values.
Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
Title
-Title <String>
Specifies the title of the order.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters?
At
-At <String>
Specifies the point in time when the order should start:
- now
- specifies that the order should start immediately
- now+1800
- specifies that the order should start with a delay of 1800 seconds, i.e. 30 minutes later.
- yyyy-mm-dd HH:MMSS
- specifies that the order should start at the specified point in time.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters?
State
-State <String>
Specifies that the order should enter the job chain at the job chain node that
is assigend the specified state.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters?
EndState
-EndState <String>
Specifies that the order should leave the job chain at the job chain node that
is assigend the specified state.
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters?
Replace
-Replace <SwitchParameter>
Specifies that the order should replace an existing order with the same order identification.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?
Immediate
-Immediate <SwitchParameter>
Specifies that the order is immediately submitted and that the order identification is returned
with the order object. This parameter is intended for a situation when no order identification
is provided when executing the cmdlet and when the caller wants to receive with the order object
the order identification that has been created by JobScheduler.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?
RELATED LINKS
about_jobscheduler
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
C:\PS>Add-Order -JobChain /sos/reporting/Reporting
Adds an order to the specified job chain. The order identification is generated by the JobScheduler Master.
-------------------------- EXAMPLE 2 --------------------------
C:\PS>Add-Order -Order 123 -JobChain /sos/reporting/Reporting
Adds the order "123" to the specified job chain.
-------------------------- EXAMPLE 3 --------------------------
C:\PS>Add-Order -JobChain /sos/reporting/Reporting -At "now+3600" -Parameters @{'param1'='value1'; 'param2'='value2'}
Adds an order to the specified job chain. The order will start one hour later and will use the
parameters from the specified hashmap.