Page History
...
Stop-JS7Order
SYNOPSIS
Cancels and removes orders an order in the JS7 Controller.
SYNTAX
Stop-JS7Order [-OrderId] <String> [-Kill] [[-Directory] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Only Ad hoc orders can be removed. Such orders are not permanently stored in files
but instead have been added on-the-fly. Typically ad hoc orders are created
for one-time execution of a workflow.
Orders are selected for removal
* by Orders are cancelled and removed by
* a pipelined object, e.g. the output of the Get-JobSchedulerOrder JS7Order cmdlet
* by specifying an individual order with the -OrderId and -Workflow parameters.parameter.
The following REST Web Service API resources are used:
* /orders/cancel
PARAMETERS
OrderId
-OrderId <String>
Specifies the identifier of an order. Both parameters -OrderId and -Workflow have to be specified if no pipelined order objects are used.
| 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 |
Directory
-Directory <String>
| Required? | false |
| Position? | 2 |
| Default value | / |
| 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? | 32 |
| 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? | 43 |
| 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? | 54 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
WhatIf
-WhatIf <SwitchParameter>
| Required? | false |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Confirm
-Confirm <SwitchParameter>
| Required? | false |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
...
PS > Stop-JS7Order -OrderId 234 "#2020-11-22#T072521128-Reporting" -Kill
Cancels the order by sending a SIGKILL signal to the order's running task.
...
PS > Get-JS7Order -WorkflowPath /some_path/some_workflow | Stop-JS7Order
Retrieves and calncels cancels all orders for the given workflow. Running tasks can complete.
-------------------------- EXAMPLE 3 --------------------------
PS > Get-JS7Order -Directory Folder /sos -Recursive | Stop-JS7Order -Kill
Retrieves and cancels all ad hoc orders from the indicated directory folder including any sub-folders. Running tasks are killed.
Overview
Content Tools