Name
Start-JobSchedulerOrder
SYNOPSIS
Starts an order for a job chain in the JobScheduler Master.
SYNTAX
Start-JobSchedulerOrder [-Order] <String> [-JobChain] <String> [[-Directory] <String>] [[-Parameters] <Hashtable>] [[-Title] <String>] [[-At] <String>] [[-State] <String>] [[-EndState] <String>] [<CommonParameters>]
DESCRIPTION
Start an existing order for a job chain.
PARAMETERS
Order
-Order <String>
Optionally specifies the identifier of an order.
| Required? | true |
| 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 orders should be started.
| Required? | true |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
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 (ByValue, ByPropertyName) |
| Accept wildcard characters? | false |
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? | 4 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Title
-Title <String>
Specifies the title of the order.
| Required? | false |
| Position? | 5 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
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:MM[:SS]
** specifies that the order should start at the specified point in time.
Default: now
| Required? | false |
| Position? | 6 |
| Default value | now |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
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? | 7 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
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? | 8 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Start-JobSchedulerOrder -JobChain /sos/reporting/Reporting
Starts an order of the specified job chain.
-------------------------- EXAMPLE 2 --------------------------
PS > Start-JobSchedulerOrder -Order 123 -JobChain /sos/reporting/Reporting
Starts the order "123" of the specified job chain.
-------------------------- EXAMPLE 3 --------------------------
PS > Start-JobSchedulerOrder -Order 123 -JobChain /sos/reporting/Reporting -At "now+1800"
Starts the specified order.
-------------------------- EXAMPLE 4 --------------------------
PS > Start-JobSchedulerOrder -JobChain /sos/reporting/Reporting -Order 548 -At "now+3600" -Parameters @{'param1'='value1'; 'param2'='value2'}
Starts an order of the specified job chain. The order will start one hour later and will use the parameters from the specified hashmap.