Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

NAME

Stop-JobSchedulerTask

SYNOPSIS

Stops a number of tasks in the JobScheduler Master.

SYNTAX

Stop-JobSchedulerTask -Task <String> -Job <String> [-Action <String>] [-Timeout <Int32>] <CommonParameters>

DESCRIPTION

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

...

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

PARAMETERS

Task

-Task <String>
Optionally specifies the identifier of a task.

...

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

Job

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

...

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

Action

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

...

Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters?

Timeout

-Timeout <Int32>
Specifies a timeout to be applied when stopping a task by use of the parameter -Action with the value "terminate".

...

Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters?

about_jobscheduler

EXAMPLES

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

...