Page History
...
Suspend-JS7Order
SYNOPSIS
Suspends orders an order in the JS7 Controller.
SYNTAX
Suspend-JS7Order [-OrderId] <String> [-Kill] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
DESCRIPTION
This cmdlet suspends orders 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 job to be completed before suspending the order. However, this behavior can be
changed by instructing the Agent to immediately kill running orders.
The following REST Web Service API resources are used:
* /orders/suspend
PARAMETERS
OrderId
-OrderId <String>
Specifies the identifier of an order.
Both parameters -Order and -Workflow have to be specified if no pipelined order objects are usedthe order.
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByValue, ByPropertyName) |
| Accept wildcard characters? | false |
...
-Kill <SwitchParameter>
Specifies if the running task for the indicated order should be sent a SIGTERM signal (default, -Kill:$false) or a SIGKILLL signal (-Kill:$true).
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-AuditComment <String>
Specifies a free text that indicates the reason for the current intervention, e.g. "business requirement", "maintenance window" etc.
The Audit Comment is visible from the Audit Log view of the JOC Cockpit.
This parameter is not mandatory. However, however, the JOC Cockpit can be configured to enforece require Audit Log comments for any all interventions.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.
This information is visible with shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobSchedulerJS7.
| Required? | false |
| Position? | 3 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
...
-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JobSchedulerJS7.
This information is visible with shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobSchedulerJS7.
| Required? | false |
| Position? | 4 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Suspend-JS7Order -OrderId Reporting -WorkflowPath /sos/reporting/Reporting"#2020-11-19#P0000000498-orderSampleWorfklow2a"
Suspends the order "Reporting" from the specified workflowwith the given ID.
-------------------------- EXAMPLE 2 --------------------------
...
Suspends orders that are available with the workflow "some_workflow_path" ) and any sub-folders.
-------------------------- EXAMPLE 4 --------------------------
PS > Get-JS7Order -WorkflowPath /test/globalssamples/chain1 workflow1 | Suspend-JS7Order
Suspends all orders for the specified workflow.
Overview
Content Tools