JS7 JobScheduler

Space shortcuts

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 16 Next »

Name

Stop-JS7Order

SYNOPSIS

Cancels and removes an order in the JS7 Controller

SYNTAX

Stop-JS7Order [-OrderId] <String> [-Kill] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

Orders are cancelled and removed. Orders are selected for removal

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

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

Kill

-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 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 JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforece Audit Log comments for any 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 visible with the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobScheduler.

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 JobScheduler.

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

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

about_JS7

EXAMPLES

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

PS > Stop-JS7Order -OrderId 234 -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.

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

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

Retrieves and cancels all orders from the indicated folder including any sub-folders.

  • No labels