NAME
Update-JobSchedulerOrder
SYNOPSIS
Updates a number of orders in the JobScheduler Master.
SYNTAX
Update-JobSchedulerOrder -Order <String> -JobChain <String> [-Directory <String>] -Action <String> [-Parameters <Hashtable>] [-Title <String>] [-At <String>] [[-Stat
e] <String>] [-EndState <String>] <CommonParameters>
DESCRIPTION
Updating orders includes operations to suspend, resume and reset orders.
Orders are selected for update
- by a pipelined object, e.g. the output of the Get-Order cmdlet
- by specifying an individual order with the -Order and -JobChain parameters.
PARAMETERS
Order
-Order <String>
Specifies the identifier of an order.
Both parameters -Order and -JobChain have to be specified if no pipelined order objects are used.
Required? true
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 updated.
Both parameters -Order and -JobChain have to be specified if no pipelined order objects are used.
Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
Directory
-Directory <String>
Optionally specifies the folder where the job chain is located. The directory is determined
from the root folder, i.e. the "live" directory.
If the -JobChain parameter specifies the name of job chain then the location specified from the
-Directory parameter is added to the job chain location.
Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
Action
-Action <String>
Specifies the action to be applied to an order:
- Action "start"
- starts an order, i.e. the order will proceed the next step in a job chain.
- Action "suspend"
- Suspends an order, i.e. the order is stopped and will not continue without being resumed.
- Action "resume"
- Resumes a suspended order.
- Action "reset"
- Resets an order that will be moved to its initial state in a job chain.
- Action "end_setback"
- Ends any delays that are applied to an order for repeated execution by a setback operation.
Required? true
Position? 4
Default value
Accept pipeline input? false
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? 5
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
Title
-Title <String>
Specifies the title of the order.
Required? false
Position? 6
Default value
Accept pipeline input? true (ByPropertyName)
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.
This parameter is considered if -Action "start" is used.
Default: now
Required? false
Position? 7
Default value
Accept pipeline input? true (ByPropertyName)
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? 8
Default value
Accept pipeline input? true (ByPropertyName)
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? 9
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?
RELATED LINKS
about_jobscheduler
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
C:\PS>Update-Order -Order Reporting -JobChain /sos/reporting/Reporting -Action suspend
Suspends the order "Reporting" from the specified job chain.
-------------------------- EXAMPLE 2 --------------------------
C:\PS>Get-Order | Update-Order -Action reset
Resets all orders and moves them to their initial state.
-------------------------- EXAMPLE 3 --------------------------
C:\PS>Get-Order -Directory / -NoSubfolders | Update-Order -Action resume
Updates all orders that are configured with the root folder ("live" directory)
without consideration of subfolders to be resumed.
-------------------------- EXAMPLE 4 --------------------------
C:\PS>Get-Order -JobChain /test/globals/chain1 | Update-Order -Action end_setback
Ends any delays for repeated execution for all orders for job chain "chain1" from the folder "/test/globals".
-------------------------- EXAMPLE 5 --------------------------
C:\PS>Update-Order -JobChain /sos/reporting/Reporting -Order 548 -Action start -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.