Page History
...
Suspend-JS7Order [-OrderId] <String> [-KillForce] [-Reset] [-Deep] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
...
This cmdlet suspends an order in a JS7 Controller.
Suspended orders can later on be resumed by use of the Resume-JS7Order cmdlet.
If an order is in a running state, for example if a job is executed for the order then by default the
Agent will wait for that the job to be completed before suspending the order. However, this This behavior can be
changed by instructing the Agent to immediately kill foribly terminate running ordersjobs.
The following REST Web Service API resources are used:
* /orders/suspend
...
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByValue, ByPropertyName) |
| Accept wildcard characters? | false |
...
Force
-Kill Force <SwitchParameter>
Specifies if the running task for the indicated order should be sent a SIGTERM signal (default, -KillForce:$false) or a SIGKILLL signal (-Kill:$true)Force:$true).
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Reset
-Reset <SwitchParameter>
Specifies that the instruction currently executed by the order will be reset.
The Retry Instruction and Cycle Instruction when resumed will use the initial retry/cycle counter.
Without reset option an order can be resumed from the retry/cycle counter with which it has been suspended.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Deep
-Deep <SwitchParameter>
Specifies that child orders in a Fork-Join Instruction or ForkList-Join Instruction will be subject to suspension.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
Overview
Content Tools