Page History

...

Update-JobSchedulerJob

SYNOPSIS

Stops Updates a number of jobs in the JobScheduler Master.

...

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

DESCRIPTION

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

Jobs Tasks to be stopped are selected

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

PARAMETERS

Job

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

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 <String>
Specifies the action to be applied to stop a task:

• Action "terminatestop"
  • 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.
  • jobs are stopped immediately. Any running tasks are continued to completion.
  • a stopped job does not execute any tasks. Orders in a job chain wait for stopped jobs to be resumed.

• Action "unstop"
  • unstops a previously stopped job
  Action "kill"
  • tasks are killed immediately.

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

...

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

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

Terminates Stops an individual taskjob.

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

C:\PS>Get-Task Job | Stop-TaskUpdate-Job -Action unstop

Unstops all jobs that have previously been stoppedTerminates all running and enqueued tasks for all jobs.

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

C:\PS>Get-Task Job -Directory /some_dir -NoSubfolders | StopUpdate-Task Job -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

stop

Stops all jobs from the specified directory
without consideration of subfoldersTerminates all tasks for job "job1" from the folder "/test/globals".