Tasks - Command Arguments¶
Complete Tasks¶
CompleteJobTask¶
Description:
Marks the specified Task for the Job as complete.
Syntax:
deadlinecommand -CompleteJobTask <Job ID> <Task ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Task ID> |
The Task ID |
Example:
Complete Task 0 of the Job:
C:\>deadlinecommand -CompleteJobTask 5b747b30c3ca512de42d01d2 0
Completed task 0 for job 5b747b30c3ca512de42d01d2
The Task may not be already in the Completed state for the command to succeed:
C:\>deadlinecommand -CompleteJobTask 5b747b30c3ca512de42d01d2 0
Error: Cannot mark a task with status Completed complete (System.Exception)
CompleteJobTasks¶
Description:
Completes the specified Tasks for the Job.
Syntax:
deadlinecommand -CompleteJobTasks <Job ID> <Task IDs> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Task IDs> |
The comma separated list of Task IDs |
Example:
Complete Tasks 1,2 and 3 of the Job:
C:\>deadlinecommand -CompleteJobTasks 5b747b30c3ca512de42d01d2 1,2,3
Completed task 1 for job 5b747b30c3ca512de42d01d2
Completed task 2 for job 5b747b30c3ca512de42d01d2
Completed task 3 for job 5b747b30c3ca512de42d01d2
If any of the Tasks in the list is in the Completed state, the whole command will fail. In the example below, Task 4 is not Completed, but 2 and 3 are:
C:\>deadlinecommand -CompleteJobTasks 5b747b30c3ca512de42d01d2 2,3,4
Error: Cannot mark a task with status Completed complete (System.Exception)
Fail Tasks¶
FailJobTask¶
Description:
Fails the specified Task for the Job.
Syntax:
deadlinecommand -FailJobTask <Job ID> <Task ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Task ID> |
The Task ID |
Example:
Fail Task 0 of the Job:
C:\>deadlinecommand -FailJobTask 5b747b30c3ca512de42d01d2 0
Failed task 0 for job 5b747b30c3ca512de42d01d2
The Task can be in any state except for the Failed state:
C:\>deadlinecommand -FailJobTask 5b747b30c3ca512de42d01d2 0
Error: Cannot fail a task with status Failed (System.Exception)
FailJobTasks¶
Description:
Fails the specified Tasks for the Job.
Syntax:
deadlinecommand -FailJobTasks <Job ID> <Task IDs> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Task IDs> |
The comma separated list of Task IDs |
Example:
Fail Tasks 1,2 and 3 of the Job - this works even if Tasks have already been marked as Failed:
C:\>deadlinecommand -FailJobTasks 5b747b30c3ca512de42d01d2 1,2,3
Failed task 1 for job 5b747b30c3ca512de42d01d2
Failed task 2 for job 5b747b30c3ca512de42d01d2
Failed task 3 for job 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -FailJobTasks 5b747b30c3ca512de42d01d2 1,2,3
Failed task 1 for job 5b747b30c3ca512de42d01d2
Failed task 2 for job 5b747b30c3ca512de42d01d2
Failed task 3 for job 5b747b30c3ca512de42d01d2
Get Task Data¶
GetJobTask¶
Description:
Display the specified Task for the Job.
Syntax:
deadlinecommand -GetJobTask <Job ID> <Task ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Task ID> |
The Task ID |
Example:
C:\>deadlinecommand -GetJobTask 5b747b30c3ca512de42d01d2 1
AverageRam=0
AverageRamPercentage=0
AverageSwap=1272754
CompletedDateTime=Jan 01/01 00:00:00
CpuUtilisation=0
ErrorCount=0
ExtraElements=
FrameString=1-1
ID=5b747b30c3ca512de42d01d2_1
ImageFileSize=-1
IsStarting=False
JobID=5b747b30c3ca512de42d01d2
Name=1_1-1
NormalizedRenderTime=10675199.02:48:05.4775807
PeakCpuUsage=0
PeakRamPercentage=0
PeakRamUsage=0
PeakSwap=1471688
Progress=100 %
RenderStartTime=Jan 01/01 00:00:00
RenderStatus=
RenderTime=10675199.02:48:05.4775807
RenderTimeMultiplier=1
SlaveName=YWG-9902945169
Status=Failed
TaskAverageRam=0
TaskAverageRamPercentage=0
TaskAverageSwap=1272754
TaskCompletedDateTime=Jan 01/01 00:00:00
TaskCpuUtilisation=0
TaskErrorCount=0
TaskFrameList=1
TaskFrameString=1-1
TaskId=1
TaskID=1
TaskIsStarted=False
TaskJobId=5b747b30c3ca512de42d01d2
TaskName=1_1-1
TaskNormalizedRenderTime=10675199.02:48:05.4775807
TaskOutputFileSize=-1
TaskPeakCpuUsage=0
TaskPeakRamPercentage=0
TaskPeakRamUsage=0
TaskPeakSwap=1471688
TaskProgress=100 %
TaskProperties=Deadline.Jobs.TaskProperties
TaskRenderStartTime=Jan 01/01 00:00:00
TaskRenderStatus=
TaskRenderTime=10675199.02:48:05.4775807
TaskRenderTimeMultiplier=1
TaskSlaveName=YWG-9902945169
TaskStartTime=Jan 01/01 00:00:00
TaskStatus=Failed
TaskTime=10675199.02:48:05.4775807
TaskTotalCpuClocks=0
TaskUsedCpuClocks=0
TaskWaitingToStart=False
TotalCpuClocks=0
UsedCpuClocks=0
WaitingToStart=False
C:\>
GetJobTaskAverageTime¶
Description:
Display average Task render time for the Job.
Syntax:
deadlinecommand -GetJobTaskAverageTime <Job ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
Example:
C:\>deadlinecommand -GetJobTaskAverageTime 5b747b30c3ca512de42d01d2
TaskAverageRenderTime=00d 00h 12m 34s
GetJobTaskAverageTimeNorm¶
Description:
Display average Task normalized render time for the Job.
Syntax:
deadlinecommand -GetJobTaskAverageTimeNorm <Job ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
Example:
C:\>deadlinecommand -GetJobTaskAverageTimeNorm 5b747b30c3ca512de42d01d2
TaskAverageNormalizedRenderTime==00d 00h 12m 34s
GetJobTaskIds¶
Description:
Display the Task IDs for the Job.
Syntax:
deadlinecommand -GetJobTaskIds <Job ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
Example:
C:\>deadlinecommand -GetJobTaskIds 5b747b30c3ca512de42d01d2
0
1
2
3
4
5
6
7
8
9
10
GetJobTaskLimit¶
Description:
Displays the Job Task Limit value set in the Configure Repository Options dialog.
Syntax:
deadlinecommand -GetJobTaskLimit |
Arguments:
Argument |
Description |
|---|---|
. |
No Arguments |
Example:
C:\>deadlinecommand -GetJobTaskLimit
5000
GetJobTasks¶
Description:
Display the information of the Tasks in the specified Job.
The individual Tasks will be separated by an empty line in the output.
If the optional second argument is set to True, each Task will also have a [Section] header in the form of
[<TaskID>_<RangeStart>-<RangeEnd>]
For instance, [0_0-9] would denote Task ID 0, rendering 10 frames from 0 to 9.
Syntax:
deadlinecommand -GetJobTasks <Job ID> [<Use Ini Display>] |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Use Ini Display> |
true/false (optional, default is false) |
Example:
C:\>deadlinecommand -GetJobTasks 5b747b30c3ca512de42d01d2 True
[0_0-0]
AverageRam=0
AverageRamPercentage=0
AverageSwap=1272912
CompletedDateTime=Jan 01/01 00:00:00
CpuUtilisation=0
ErrorCount=1
ExtraElements=
FrameString=0-0
ID=5b747b30c3ca512de42d01d2_0
ImageFileSize=-1
IsStarting=False
JobID=5b747b30c3ca512de42d01d2
Name=0_0-0
NormalizedRenderTime=10675199.02:48:05.4775807
PeakCpuUsage=0
PeakRamPercentage=0
PeakRamUsage=0
PeakSwap=1477584
Progress=0 %
RenderStartTime=Jan 01/01 00:00:00
RenderStatus=
RenderTime=10675199.02:48:05.4775807
RenderTimeMultiplier=1
SlaveName=
Status=Queued
TaskAverageRam=0
TaskAverageRamPercentage=0
TaskAverageSwap=1272912
TaskCompletedDateTime=Jan 01/01 00:00:00
TaskCpuUtilisation=0
TaskErrorCount=1
TaskFrameList=0
TaskFrameString=0-0
TaskId=0
TaskID=0
TaskIsStarted=False
TaskJobId=5b747b30c3ca512de42d01d2
TaskName=0_0-0
TaskNormalizedRenderTime=10675199.02:48:05.4775807
TaskOutputFileSize=-1
TaskPeakCpuUsage=0
TaskPeakRamPercentage=0
TaskPeakRamUsage=0
TaskPeakSwap=1477584
TaskProgress=0 %
TaskProperties=Deadline.Jobs.TaskProperties
TaskRenderStartTime=Jan 01/01 00:00:00
TaskRenderStatus=
TaskRenderTime=10675199.02:48:05.4775807
TaskRenderTimeMultiplier=1
TaskSlaveName=
TaskStartTime=Jan 01/01 00:00:00
TaskStatus=Queued
TaskTime=10675199.02:48:05.4775807
TaskTotalCpuClocks=0
TaskUsedCpuClocks=0
TaskWaitingToStart=False
TotalCpuClocks=0
UsedCpuClocks=0
WaitingToStart=False
[1_1-1]
AverageRam=0
...
Note
The full output of this command is too long to include here - each Task’s info block looks similar to the Task 0 above.
GetJobTaskTotalTime¶
Description:
Displays the total render time for the Tasks in the specified Job.
Syntax:
deadlinecommand -GetJobTaskTotalTime <Job ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
Example:
C:\>deadlinecommand -GetJobTaskTotalTime 5b747b30c3ca512de42d01d2
TaskTotalRenderTime=00d 01h 23m 45s
GetJobTaskTotalTimeNorm¶
Description:
Display total Task normalized render time for the Job.
Syntax:
deadlinecommand -GetJobTaskTotalTimeNorm <Job ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
Example:
C:\>deadlinecommand -GetJobTaskTotalTimeNorm 5b747b30c3ca512de42d01d2
TaskTotalNormalizedRenderTime=00d 01h 23m 45s
GetTaskProgress¶
Description:
Display progress information about the Job’s Tasks.
Syntax:
deadlinecommand -GetTaskProgress <Job ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
Example:
C:\>deadlinecommand -GetTaskProgress 5b747b30c3ca512de42d01d2
JobProgress=0%
ElapsedJobRenderTime=676d 21h 14m 12s
TotalTaskRenderTime=00d 00h 00m 00s
AverageTaskRenderTime=00d 00h 00m 00s
AverageFrameRenderTime=00d 00h 00m 00s
TotalNormalizedTaskRenderTime=00d 00h 00m 00s
AverageNormalizedTaskRenderTime=00d 00h 00m 00s
AverageNormalizedFrameRenderTime=00d 00h 00m 00s
EstimatedJobTimeRemaining=??d ??h ??m ??s
Requeue Task¶
RequeueJobTask¶
Description:
Requeues the specified Task for the Job.
Syntax:
deadlinecommand -RequeueJobTask <Job ID> <Task ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Task ID> |
The Task ID |
Example:
The Task may not be in the Queued or Failed state.
C:\>deadlinecommand -CompleteJobTask 5b747b30c3ca512de42d01d2 10
Completed task 10 for job 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -RequeueJobTask 5b747b30c3ca512de42d01d2 10
Requeued task 10 for job 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -RequeueJobTask 5b747b30c3ca512de42d01d2 10
Error: Cannot requeue a task with status Queued (System.Exception)
If the Task is in the Failed state, you must use the ResumeFailedJobTask command to bring it into the Queued state:
C:\>deadlinecommand -RequeueJobTask 5b747b30c3ca512de42d01d2 0
Error: Cannot requeue a task with status Failed (System.Exception)
C:\>deadlinecommand -ResumeFailedJobTask 5b747b30c3ca512de42d01d2 0
Resumed failed task 0 for job 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -RequeueJobTask 5b747b30c3ca512de42d01d2 0
Error: Cannot requeue a task with status Queued (System.Exception)
RequeueJobTasks¶
Description:
Requeues the specified Tasks for the Job.
Syntax:
deadlinecommand -RequeueJobTasks <Job ID> <Task IDs> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Task IDs> |
The comma separated list of Task IDs |
Example:
First we will complete the Tasks before requeueing them. If they are already queued, the command will do nothing.
C:\>deadlinecommand -CompleteJobTasks 5b747b30c3ca512de42d01d2 2,3,4
Completed task 2 for job 5b747b30c3ca512de42d01d2
Completed task 3 for job 5b747b30c3ca512de42d01d2
Completed task 4 for job 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -RequeueJobTasks 5b747b30c3ca512de42d01d2 2,3,4
Requeued task 2 for job 5b747b30c3ca512de42d01d2
Requeued task 3 for job 5b747b30c3ca512de42d01d2
Requeued task 4 for job 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -RequeueJobTasks 5b747b30c3ca512de42d01d2 2,3,4
C:\>
Suspend Task¶
SuspendJobTask¶
Description:
Suspends the specified Task for the Job.
Syntax:
deadlinecommand -SuspendJobTask <Job ID> <Task ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Task ID> |
The Task ID |
Example:
The Task must be in an active state (Queued or Rendering):
C:\>deadlinecommand -SuspendJobTask 5b747b30c3ca512de42d01d2 0
Suspended task 0 for job 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -SuspendJobTask 5b747b30c3ca512de42d01d2 0
Error: Cannot suspend a task with status Suspended (System.InvalidOperationException)
C:\>deadlinecommand -FailJobTask 5b747b30c3ca512de42d01d2 0
Failed task 0 for job 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -SuspendJobTask 5b747b30c3ca512de42d01d2 0
Error: Cannot suspend a task with status Failed (System.InvalidOperationException)
SuspendJobTasks¶
Description:
Suspends the specified Tasks for the Job.
Syntax:
deadlinecommand -SuspendJobTasks <Job ID> <Task IDs> |
Arguments:
Suspends the specified Tasks for the Job.
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Task IDs> |
The comma separated list of Task IDs |
Example:
The Tasks can be in any state, including Failed:
C:\>deadlinecommand -SuspendJobTasks 5b747b30c3ca512de42d01d2 1,2,3
Suspended tasks [1,2,3] for job 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -FailJobTasks 5b747b30c3ca512de42d01d2 1,2,3
Failed task 1 for job 5b747b30c3ca512de42d01d2
Failed task 2 for job 5b747b30c3ca512de42d01d2
Failed task 3 for job 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -SuspendJobTasks 5b747b30c3ca512de42d01d2 1,2,3
Suspended tasks [1,2,3] for job 5b747b30c3ca512de42d01d2
Resume Task¶
ResumeJobTask¶
Description:
Resumes the specified suspended Task for the Job.
Syntax:
deadlinecommand -ResumeJobTask <Job ID> <Task ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Task ID> |
The Task ID |
Example:
The Task must be in Suspended state for the command to succeed:
C:\>deadlinecommand -SuspendJobTask 5b747b30c3ca512de42d01d2 0
Suspended task 0 for job 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -ResumeJobTask 5b747b30c3ca512de42d01d2 0
Resumed suspended task 0 for job 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -ResumeJobTask 5b747b30c3ca512de42d01d2 0
Error: Cannot resume a task with status Queued (System.InvalidOperationException)
ResumeJobTasks¶
Description:
Resumes the specified suspended Tasks for the Job.
Syntax:
deadlinecommand -ResumeJobTasks <Job ID> <Task IDs> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Task IDs> |
The comma separated list of Task IDs |
Example:
The Tasks can be in any state, including Failed:
C:\>deadlinecommand -SuspendJobTasks 5b747b30c3ca512de42d01d2 1,2,3
Suspended tasks [1,2,3] for job 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -ResumeJobTasks 5b747b30c3ca512de42d01d2 1,2,3
Resumed suspended tasks [1,2,3] for job 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -ResumeJobTasks 5b747b30c3ca512de42d01d2 1,2,3
Resumed suspended tasks [1,2,3] for job 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -FailJobTasks 5b747b30c3ca512de42d01d2 1,2,3
Failed task 1 for job 5b747b30c3ca512de42d01d2
Failed task 2 for job 5b747b30c3ca512de42d01d2
Failed task 3 for job 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -ResumeJobTasks 5b747b30c3ca512de42d01d2 1,2,3
Resumed suspended tasks [1,2,3] for job 5b747b30c3ca512de42d01d2
ResumeFailedJobTask¶
Description:
Resumes the specified failed Task for the Job.
Syntax:
deadlinecommand -ResumeFailedJobTask <Job ID> <Task ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Task ID> |
The Task ID |
Example:
See the example for RequeueJobTask
ResumeFailedJobTasks¶
Description:
Resumes the specified failed Tasks for the Job.
Syntax:
deadlinecommand -ResumeFailedJobTasks <Job ID> <Task IDs> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Task IDs> |
The comma-separated list of Task IDs |
Example:
We will fail some Tasks first, then resume them:
C:\>deadlinecommand -FailJobTasks 5b747b30c3ca512de42d01d2 1,2,3
Failed task 1 for job 5b747b30c3ca512de42d01d2
Failed task 2 for job 5b747b30c3ca512de42d01d2
Failed task 3 for job 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -ResumeFailedJobTasks 5b747b30c3ca512de42d01d2 1,2,3
