JS7 JobScheduler

Space shortcuts

Page tree

Name

Stop-JS7Order

SYNOPSIS

Cancels an order in the JS7 Controller

SYNTAX

Stop-JS7Order [-OrderId] <String> [-Force] [-Deep] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

This cmdlet cancels order in a JS7 Controller.

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 the job to be completed before cancelling the order. This behavior can be
changed by instructing the Agent to foribly terminate running jobs.

Orders are cancelled and removed by

* a pipelined object, e.g. the output of the Get-JS7Order cmdlet
* specifying an individual order with the -OrderId parameter.

The following REST Web Service API resources are used:

* /orders/cancel

PARAMETERS

OrderId

-OrderId <String>
Specifies the identifier of an order.

Required?true
Position?1
Default value
Accept pipeline input?true (ByValue, ByPropertyName)
Accept wildcard characters?false

Force

-Force <SwitchParameter>
Specifies if the running task for the indicated order should be sent a SIGTERM signal (default, -Force:$false) or a SIGKILLL signal (-Force:$true).

Required?false
Position?named
Default valueFalse
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 cancellation.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

AuditComment

-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, the JOC Cockpit can be configured to require Audit Log comments for all interventions.

Required?false
Position?2
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

AuditTimeSpent

-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.

This information is shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JS7.

Required?false
Position?3
Default value0
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 JS7.

This information is shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JS7.

Required?false
Position?4
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

about_JS7

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

PS > Stop-JS7Order -OrderId "#2020-11-22#T072521128-Reporting" -Kill

Cancels the order by sending a SIGKILL signal to the order's running task.

-------------------------- EXAMPLE 2 --------------------------

PS > Get-JS7Order -WorkflowPath /some_path/some_workflow | Stop-JS7Order

Retrieves and cancels all orders for the given workflow. Running tasks can complete.

-------------------------- EXAMPLE 3 --------------------------

PS > Get-JS7Order -Folder /sos -Recursive | Stop-JS7Order -Kill

Retrieves and cancels all orders from the indicated folder including any sub-folders. Running tasks are killed.

  • No labels