PowerShell CLI - Cmdlets - Update-JobSchedulerJob

NAME

Update-JobSchedulerJob

SYNOPSIS

Stops a number of jobs in the JobScheduler Master.

SYNTAX

Update-JobSchedulerJob -Job <String> -Action <String> <CommonParameters>

DESCRIPTION

Stopping tasks includes operations to terminate tasks, e.g. by a SIGTERM signal, and to kill tasks immediately.

Tasks to be stopped are selected

• by a pipelined object, e.g. the output of the Get-Task cmdlet
• by specifying an individual task with the -Id and -Job parameters.

PARAMETERS

Job

-Job <String>
Optionally specifies the path and name of a job for which tasks should be terminated.

Both parameters -Id and -Job have to be specified if no pipelined task objects are used.

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

Action

-Action <String>
Specifies the action to be applied to stop a task:

• Action "terminate"
  • For shell jobs
    • in a Unix environment the task is sent a SIGTERM signal and - in case of the timeout parameter being used -
      after expiration of the timeout a SIGKILL signal is sent.
    • in a Windows environment the task is killed immediately.
  • For API jobs
    • the method spooler_process() of the respective job will not be called by JobScheduler any more.
    • the task is expected to terminate normally after completion of its spooler_process() method.

• Action "kill"
  • tasks are killed immediately.

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

RELATED LINKS

about_jobscheduler

EXAMPLES

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

C:\PS>Stop-Task -Id 81073 -Job /sos/dailyschedule/CheckDaysSchedule

Terminates an individual task.

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

C:\PS>Get-Task | Stop-Task

Terminates all running and enqueued tasks for all jobs.

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

C:\PS>Get-Task -Directory / -NoSubfolders | Stop-Task -Action terminate -Timeout 30

Terminates all running and enqueued tasks that are configured with the root folder ("live" directory)
without consideration of subfolders.

For Unix environments tasks are sent a SIGTERM signal and after expiration of 30s a SIGKILL signal.

-------------------------- EXAMPLE 4 --------------------------

C:\PS>Get-Task -Job /test/globals/job1 | Stop-Task

Terminates all tasks for job "job1" from the folder "/test/globals".