Jobs - Command Arguments¶
Get Jobs¶
GetJobIds¶
Description:
Displays all Job IDs.
Syntax:
deadlinecommand -GetJobIds |
Arguments:
Argument |
Description |
|---|---|
. |
No arguments |
Example:
C:\>deadlinecommand -GetJobIds
5980fbb13e08523c444eacd3
5992603e3e08523248bcca63
59935a6b3e08523f3ccd9a23
59b775fa3e085266e410a04d
59b782be3e085266e410a051
5a3c4c893e0852bbe8e7887d
5aa7230a3e08521d90a276e2
5b2acd43c3ca5112c8651645
...
GetJobIdsFilter¶
Description:
Display Job IDs of Jobs that fulfill ANY of the specified filters.
Syntax:
deadlinecommand -GetJobIdsFilter <Filter 1> <…> |
Arguments:
Argument |
Description |
|---|---|
<Filter 1> |
A filter, in the form of <Setting=Value> |
<…> |
Additional filters… |
Example:
C:\>deadlinecommand -GetJobIdsFilter Status=Queued UserName=john
5b747b30c3ca512de42d01d2
5d434e08c3ca51565c1b44cb
C:\>
GetJobIdsFilterAnd¶
Description:
Display Job IDs of Jobs that fulfill ALL the specified filters.
Syntax:
deadlinecommand -GetJobIdsFilterAnd <Filter 1> <…> |
Arguments:
Argument |
Description |
|---|---|
<Filter 1> |
A filter, in the form of <Setting=Value> |
<…> |
Additional filters… |
Example:
C:\>deadlinecommand -GetJobIdsFilterAnd Status=Queued UserName=john
5d434e08c3ca51565c1b44cb
C:\>
GetJobsFilter¶
Description:
Display information of Jobs that fulfill ANY of the specified filters.
Syntax:
deadlinecommand -GetJobsFilter <Filter 1> <…> |
Arguments:
Argument |
Description |
|---|---|
<Filter 1> |
A filter, in the form of <Setting=Value> |
<…> |
Additional filters… |
Example:
C:\>deadlinecommand -GetJobsFilter UserName=john UserName=ben
Note
The output of this command is too long to include here.
GetJobsFilterAnd¶
Description:
Display information of Jobs that fulfill ALL the specified filters.
Syntax:
deadlinecommand -GetJobsFilterAnd <Filter 1> <…> |
Arguments:
Argument |
Description |
|---|---|
<Filter 1> |
A filter, in the form of <Setting=Value> |
<…> |
Additional filters… |
Example:
C:\>deadlinecommand -GetJobsFilterAnd Status=Queued UserName=john
Note
The output of this command is too long to include here.
GetJobsFilterIni¶
Description:
Display information of Jobs that fulfill the specified filters, in an INI format.
Syntax:
deadlinecommand -GetJobsFilterIni <Filter 1> <…> |
Arguments:
Argument |
Description |
|---|---|
<Filter 1> |
A filter, in the form of <Setting=Value> |
<…> |
Additional filters… |
Example:
C:\>deadlinecommand -GetJobsFilterIni Status=Suspended UserName=john
Note
The output of this command is too long to include here.
GetJobsFilterIniAnd¶
Description:
Display information of Jobs that fulfill ALL the specified filters, in an ini format.
Syntax:
deadlinecommand -GetJobsFilterIniAnd <Filter 1> <…> |
Arguments:
Argument |
Description |
|---|---|
<Filter 1> |
A filter, in the form of <Setting=Value> |
<…> |
Additional filters… |
Example:
C:\>deadlinecommand -GetJobsFilterIni Status=Failed UserName=john
Note
The output of this command is too long to include here.
GetJob¶
Description:
Display information for the specified Job(s).
Syntax:
deadlinecommand -GetJob <Job ID(s)> [<Use Ini Display>] |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
<Use Ini Display> |
true/false (optional, default is false) |
Example:
Note
C:\>deadlinecommand -GetJob 5b747b30c3ca512de42d01d2 True
[5b747b30c3ca512de42d01d2]
AuxiliarySubmissionFileNames=
AWSPortalAssets=
BadSlaves=
BatchName=
ChunkSize=1
Comment=
CompletedChunks=0
CompletedDateTime=Jan 01/01 00:00:00
CompletedDateTimeString=01/01/0001 00:00:00
CompletedFrames=0
ConcurrentTasks=1
CustomEventPluginDirectory=
CustomPluginDirectory=
Department=
EmailNotification=False
EnableAutoTimeout=False
EnableFrameTimeouts=False
EnableTimeoutsForScriptTasks=False
EnvironmentDictionary=
ErrorReports=2
EventOptIns=
ExtraElements=
ExtraInfo0=
ExtraInfo1=
ExtraInfo2=
...
SynchronizeAllAuxiliaryFiles=False
TaskCount=11
TaskExtraInfoName0=
TaskExtraInfoName1=
TaskExtraInfoName2=
TaskExtraInfoName3=
TaskExtraInfoName4=
TaskExtraInfoName5=
TaskExtraInfoName6=
TaskExtraInfoName7=
TaskExtraInfoName8=
TaskExtraInfoName9=
TaskTimeout=00:00:00
TaskTimeoutSeconds=0
ThursdayStartTime=-10675199.02:48:05.4775808
ThursdayStopTime=-10675199.02:48:05.4775808
TileJob=False
TileJobFrame=0
TileJobTileCount=0
TileJobTilesInX=0
TileJobTilesInY=0
TotalRenderTime=00:00:00
TotalRenderTimeTicks=0
TuesdayStartTime=-10675199.02:48:05.4775808
TuesdayStopTime=-10675199.02:48:05.4775808
UseJobEnvironmentOnly=False
UserName=aws
WednesdayStartTime=-10675199.02:48:05.4775808
WednesdayStopTime=-10675199.02:48:05.4775808
WhitelistFlag=True
Note
The output of this command is too long to include here in full.
GetJobs¶
Description:
Displays information for all the Jobs.
Syntax:
deadlinecommand -GetJobs [<Use Ini Display>] |
Arguments:
Argument |
Description |
|---|---|
<Use Ini Display> |
true/false (optional, default is false) |
Example:
Note
C:\>deadlinecommand -GetJobs True
Note
The output of this command is too long to include here.
Modify Job States¶
SuspendJob¶
Description:
Suspends the Job.
Syntax:
deadlinecommand -SuspendJob <Job ID(s)> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
Example:
Suspend the Job with ID ‘5b747b30c3ca512de42d01d2’, including the Tasks that are currently rendering:
C:\>deadlinecommand -SuspendJob 5b747b30c3ca512de42d01d2
Suspended job(s) 5b747b30c3ca512de42d01d2
If the Job is already suspended, the following message will be printed:
C:\>deadlinecommand -SuspendJob 5b747b30c3ca512de42d01d2
Could not suspend the following job(s) 5b747b30c3ca512de42d01d2
SuspendJobNonRenderingTasks¶
Description:
Suspends the tasks that are not rendering for the Job.
Syntax:
deadlinecommand -SuspendJobNonRenderingTasks <Job ID(s)> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
Example:
Suspends only the tasks of Job with ID ‘5b747b30c3ca512de42d01d2’ that are not rendering .
C:\>deadlinecommand -SuspendJobNonRenderingTasks 5b747b30c3ca512de42d01d2
ResumeJob¶
Description:
Resumes the Job.
Syntax:
deadlinecommand -ResumeJob <Job ID(s)> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
Example:
To resume a Job, it must be in the Suspended state:
C:\>deadlinecommand -SuspendJob 5b747b30c3ca512de42d01d2
Suspended job(s) 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -ResumeJob 5b747b30c3ca512de42d01d2
Resumed job(s) 5b747b30c3ca512de42d01d2
C:\>
If the Job is already resumed (in Queued state), the following message will be printed:
C:\>deadlinecommand -ResumeJob 5b747b30c3ca512de42d01d2
Could not resume the following job(s): 5b747b30c3ca512de42d01d2
C:\>
Note
If the Job ID is invalid, no message will be printed
C:\>deadlinecommand -ResumeJob notavalidID
C:\>
ResumeFailedJob¶
Description:
Resumes the failed Job.
Syntax:
deadlinecommand -ResumeFailedJob <Job ID(s)> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
Example:
The Job’s state must be Failed for this command to succeed:
C:\>deadlinecommand -ResumeFailedJob 5b747b30c3ca512de42d01d2
Could not resume the following job(s) as they are not in the failed state: 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -FailJob 5b747b30c3ca512de42d01d2
Marked job(s) as failed 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -ResumeFailedJob 5b747b30c3ca512de42d01d2
Resumed failed job 5b747b30c3ca512de42d01d2
C:\>
ReleasePendingJob¶
Description:
Releases the pending Job.
Syntax:
deadlinecommand -ReleasePendingJob <Job ID(s)> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
Example:
The Job’s state must be Pending for this command to succeed:
C:\>deadlinecommand -ReleasePendingJob 5b747b30c3ca512de42d01d2
Could not release the following job(s): 5b747b30c3ca512de42d01d2
C:\>
CompleteJob¶
Description:
Marks one or more Jobs as complete.
Syntax:
deadlinecommand -CompleteJob <Job ID(s)> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
Example:
The Job’s state must not be Completed for this command to succeed:
C:\>deadlinecommand -CompleteJob 5b747b30c3ca512de42d01d2
Marked job as complete 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -CompleteJob 5b747b30c3ca512de42d01d2
The following jobs were already in the completed state: 5b747b30c3ca512de42d01d2
C:\>
FailJob¶
Description:
Fails a Job.
Syntax:
deadlinecommand -FailJob <Job ID(s)> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
Example:
See the example for ResumeFailedJob
RequeueJob¶
Description:
Requeues the Job.
Syntax:
deadlinecommand -RequeueJob <Job ID(s)> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
Example:
The Job can be in any state for this command to succeed:
C:\>deadlinecommand -RequeueJob 5b747b30c3ca512de42d01d2
Requeued job(s) 5b747b30c3ca512de42d01d2
C:\>deadlinecommand -RequeueJob 5b747b30c3ca512de42d01d2
Requeued job(s) 5b747b30c3ca512de42d01d2
C:\>
ResubmitJob¶
Description:
Resubmits an existing Job with a new frame list and chunksize.
Syntax:
deadlinecommand -ResubmitJob <Job ID> <Frame List> <Chunk Size> <Submit Suspended> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The ID of the Job to resubmit |
<Frame List> |
The new frame list |
<Chunk Size> |
The new chunk size |
<Submit Suspended> |
If the Job should be submitted suspended (optional) |
Example:
C:\>deadlinecommand -ResubmitJob 5b747b30c3ca512de42d01d2 1,5,7-10 1 True
Submitting to Repository: C:\DeadlineRepository10
Submission Contains No Auxiliary Files.
Result=Success
JobID=5eeefe01c702a2509001f6da
The job was submitted successfully.
C:\>
Archive and Import Jobs¶
ArchiveJob¶
Description:
Archives the Job.
Syntax:
deadlinecommand -ArchiveJob <Job ID(s)> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
Example:
Archiving the Job created in the previous example for ResubmitJob:
C:\>deadlinecommand -ArchiveJob 5eeefe01c702a2509001f6da
Archived job 5eeefe01c702a2509001f6da
ImportJob¶
Description:
Imports the archived Job.
Syntax:
deadlinecommand -ImportJob <Delete Archive> <Archived Job File> |
Arguments:
Argument |
Description |
|---|---|
<Delete Archive> |
If the original archive should be deleted (true/false). |
<Archived Job File> |
The archived Job file. Specify multiple files as separate parameters. |
Example:
Importing the Job archived in the previous example for ArchiveJob:
C:\>deadlinecommand -ImportJob False "C:\DeadlineRepository10\jobsArchived\2020-06\aws__Redshift__Untitled 1.c4d - Main - Redshi__5eeefe01c702a2509001f6da.zip"
Imported job C:\DeadlineRepository10\jobsArchived\2020-06\aws__Redshift__Untitled 1.c4d - Main - Redshi__5eeefe01c702a2509001f6da.zip
Delete Job¶
DeleteJob¶
Description:
Deletes the Job(s).
Syntax:
deadlinecommand -DeleteJob <Job ID(s)> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
Example:
Deleting the Job imported in the previous example for ImportJob:
C:\>deadlinecommand -DeleteJob 5eeefe01c702a2509001f6da
Deleted job 5eeefe01c702a2509001f6da
Note
C:\>deadlinecommand -DeleteJob TotallyNotAValidID
Deleted job TotallyNotAValidID
GetDeletedJobIds¶
Description:
Displays all the deleted job IDs
Syntax:
deadlinecommand -GetDeletedJobIds |
Arguments:
Argument |
Description |
|---|---|
. |
No arguments |
Example:
Showing the deleted Job from the previous example for DeleteJob:
C:\>deadlinecommand -GetDeletedJobIds
5eeefe01c702a2509001f6da
GetDeletedJob¶
Description:
Display information for the deleted job(s).
Syntax:
deadlinecommand -GetDeletedJob <Job ID(s)> [<Use Ini Display>] |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The job ID, or a list of job IDs separated by commas |
<Use Ini Display> |
true/false (optional, default is false) |
Example:
C:\>deadlinecommand -GetDeletedJob 5eeefe01c702a2509001f6da
Note
The output of this command is too long to include here.
GetDeletedJobs¶
Description:
Displays information for all the deleted jobs.
Syntax:
deadlinecommand -GetDeletedJobs [<Use Ini Display>] |
Arguments:
Argument |
Description |
|---|---|
<Use Ini Display> |
true/false (optional, default is false) |
Example:
C:\>deadlinecommand -GetDeletedJobs True
Note
The output of this command is too long to include here.
UndeleteJob¶
Description:
Undeletes the Job(s).
Syntax:
deadlinecommand -UndeleteJob <Job ID(s)> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The deleted Job ID, or a list of deleted Job IDs separated by commas |
Example:
Undeleting the Job deleted in the previous example for DeleteJob:
C:\>deadlinecommand -UndeleteJob 5eeefe01c702a2509001f6da
Undeleted job 5eeefe01c702a2509001f6da
Note
C:\>deadlinecommand -UndeleteJob TotallyNotAValidID
Undeleted job TotallyNotAValidID
PurgeDeletedJob¶
Description:
Purges the deleted Job(s).
Syntax:
deadlinecommand -PurgeDeletedJob <Job ID(s)> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The deleted Job ID, or a list of deleted Job IDs separated by commas |
Example:
C:\>deadlinecommand -PurgeDeletedJob 5eeefe01c702a2509001f6da
Purged deleted job 5eeefe01c702a2509001f6da
Note
C:\>deadlinecommand -PurgeDeletedJob TotallyNotAValidID
Purged deleted job TotallyNotAValidID
Dependencies¶
SelectDependencies¶
Description:
Allows you to select a list of dependencies, then prints them to stdout.
Syntax:
deadlinecommand -SelectDependencies <Initial Dependencies> |
Arguments:
Argument |
Description |
|---|---|
<Initial Dependencies> |
A comma separated list of the initially selected dependencies (optional) |
Job Settings¶
GetJobAuxiliaryPath¶
Description:
Displays the Jobs Auxillary path
Syntax:
deadlinecommand -GetJobAuxiliaryPath <Job ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
Example:
C:\>deadlinecommand -GetJobAuxiliaryPath 5b747b30c3ca512de42d01d2
C:\DeadlineRepository10\jobs\5b747b30c3ca512de42d01d2
C:\>
GetJobDetails¶
Description:
Displays the Job details.
Syntax:
deadlinecommand -GetJobDetails <Job ID(s)> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
Example:
C:\>deadlinecommand -GetJobDetails 5b747b30c3ca512de42d01d2
Details for "5b747b30c3ca512de42d01d2":
Job
ID:5b747b30c3ca512de42d01d2
Name:Untitled 1.c4d - Main - Redshift Standalone
User:aws
Submit Date:2018/08/15 12:12:47
Submit Machine:DESKTOP-GJ9K16C
Plugin:Redshift
Mode:Normal
Frames:0-10
Frames Per Task:1
Progress:0 % (0/11)
Errors:2
Status:Queued
Start Date:2018/08/15 12:12:48
Finish Date:
Task States
Completed:0
Failed:0
Pending:0
Queued:11
Rendering:0
Suspended:0
Auxiliary Files
No auxiliary files.:
Output Directories
Output Path 1:C:\Users\AWS
Output Filenames
Output File 1:Desktop####.tif
Statistics
Running Time:675:09:30:32
Estimated Time Remaining:unknown
Total Task Time:00:00:00:00
Total Task Startup Time:00:00:00:00
Total Task Render Time:00:00:00:00
Total Normalized Task Render Time:00:00:00:00
Average Task Time:00:00:00:00
Average Task Startup Time:00:00:00:00
Average Task Render Time:00:00:00:00
Average Normalized Task Render Time:00:00:00:00
Average Frame Time:00:00:00:00
Average Normalized Frame Time:00:00:00:00
Peak RAM Usage:0 Bytes
Peak CPU Usage:0 %
Average RAM Usage:0 Bytes
Average CPU Usage:0 %
Total Output File Size:0 Bytes
Average Output File Size:0 Bytes
General Properties
Comment:
Department:
Pool:none
Secondary Pool:
Group:none
Batch Name:
Priority:50
Concurrent Tasks:1
Limit Tasks to Worker's Task Limit:Yes
On Job Complete:Do nothing
Job Is Protected:No
Re-synchronize Auxiliary Files Beteween Tasks:No
Reload Plugin Between Tasks:No
Enforce Sequential Rendering:No
Job Is Interruptible:No
Progress cut-off for Job Interruption:100
Remaining Time Threshold for Job Interruption:0
Suppress Event Plugins:No
Timeouts
Minimum Render Time:(no minimum)
Maximum Render Time:(no maximum)
Enable Timeouts for Pre/Post Job Scripts:No
Use the Timeouts for Frames instead of Tasks.:No
Auto Task Timeout:No
On Task Timeout:Error
Notifications
Override Notification Method:No
Notification Method:No Notification
Notification Users
User 1:aws
Notification Email Addresses
No notification emails:
Machine Limit
Machine Limit:(disabled)
Limit Stub Release Progress:(disabled)
Whitelisted Workers
Worker 1:desktop-gj9k16c
Limits
No limits:
Dependency Properties
Resume on Completed Dependencies:Yes
Resume on Failed Dependencies:No
Resume on Deleted Dependencies:No
Use Frame Dependencies:Yes
Frame Offset Start:0
Frame Offset End:0
Dependency Release Percentage:
Job Dependencies
Job 1:5b74aad0c3ca513524a7ae6b
Required Assets
No assets:
Failure Detection
Override Failed Job Detection:No
Override Failed Task Detection:No
Send Warning For Job Errors:Yes
Ignore Bad Worker Detection:No
Scheduling
Mode:Disabled
Scripts
Pre Job Script:
Post Job Script:
Pre Task Script:
Post Task Script:
Script Dependencies
No script dependencies:
Environment Variables
No environment variables:
Extra Info
Extra Info 0:
Extra Info 1:
Extra Info 2:
Extra Info 3:
Extra Info 4:
Extra Info 5:
Extra Info 6:
Extra Info 7:
Extra Info 8:
Extra Info 9:
Extra Info Key/Value Pairs
No extra info key/value pairs:
Redshift Properties
SceneFile:Z:\RS Scenes\v001\justABox_Main0000.rs
C:\>
GetJobLogReportFilenames¶
Description:
Gets the log report filenames for the Job.
Syntax:
deadlinecommand -GetJobLogReportFilenames <Job ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
Example:
C:\>deadlinecommand -GetJobLogReportFilenames 5b747b30c3ca512de42d01d2
C:\DeadlineRepository10\reports\jobs\1d\2\5b747b30c3ca512de42d01d2\5b747c1fae5ef133d8625e4f.bz2
C:\DeadlineRepository10\reports\jobs\1d\2\5b747b30c3ca512de42d01d2\5b747c16ae5ef133d8625e4e.bz2
C:\DeadlineRepository10\reports\jobs\1d\2\5b747b30c3ca512de42d01d2\5b747c0bae5ef133d8625e4d.bz2
C:\DeadlineRepository10\reports\jobs\1d\2\5b747b30c3ca512de42d01d2\5b747c00ae5ef133d8625e4c.bz2
C:\>
GetJobErrorReportFilenames¶
Description:
Gets the error report filenames for the Job.
Syntax:
deadlinecommand -GetJobErrorReportFilenames <Job ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
Example:
C:\>deadlinecommand -GetJobErrorReportFilenames 5b747b30c3ca512de42d01d2
C:\DeadlineRepository10\reports\jobs\1d\2\5b747b30c3ca512de42d01d2\5b747bf780a7eb0bf14d1d03.bz2
C:\DeadlineRepository10\reports\jobs\1d\2\5b747b30c3ca512de42d01d2\5eeee1efcf30205f3001e6e6.bz2
C:\>
GetJobPluginInfoKeyValue¶
Description:
Gets the value from the plugin info dictionary.
Syntax:
deadlinecommand -GetJobPluginInfoKeyValue <Job ID> <Plugin Info Key> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Plugin Info Key> |
The plugin info key to get. |
Example:
C:\>deadlinecommand -GetJobPluginInfoKeyValue 5b747b30c3ca512de42d01d2 SceneFile
Z:\RS Scenes\v001\justABox_Main0000.rs
C:\>
SetJobPluginInfoKeyValue¶
Description:
Sets the value of the specified key within the plugin info dictionary.
Syntax:
deadlinecommand -SetJobPluginInfoKeyValue <Job ID> <Plugin Info Key> <Value> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Plugin Info Key> |
The plugin info key to get. |
<Value> |
The new value |
Example:
C:\>deadlinecommand -SetJobPluginInfoKeyValue 5b747b30c3ca512de42d01d2 SceneFile "Z:\RS Scenes\v001\justABox_Main0001.rs"
Set the key: SceneFile to: Z:\RS Scenes\v001\justABox_Main0001.rs
C:\>deadlinecommand -GetJobPluginInfoKeyValue 5b747b30c3ca512de42d01d2 SceneFile
Z:\RS Scenes\v001\justABox_Main0001.rs
C:\>
GetJobExtraInfoKeyValue¶
Description:
Gets the value from the extra info dictionary.
Syntax:
deadlinecommand -GetJobExtraInfoKeyValue <Job ID> <Extra Info Key> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Extra Info Key> |
The extra info key to get. |
Example:
See the example for the following command SetJobExtraInfoKeyValue
SetJobExtraInfoKeyValue¶
Description:
Sets the value of the specified key within the extra info dictionary.
Syntax:
deadlinecommand -SetJobExtraInfoKeyValue <Job ID> <Extra Info Key> <Value> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Extra Info Key> |
The extra info key to get. |
<Value> |
The new value |
Example:
C:\>deadlinecommand -SetJobExtraInfoKeyValue 5b747b30c3ca512de42d01d2 CostCenter 033
Set the key: CostCenter to: 033
C:\>deadlinecommand -GetJobExtraInfoKeyValue 5b747b30c3ca512de42d01d2 CostCenter
033
C:\>
GetJobSetting¶
Description:
Gets the value of a setting for the Job.
Syntax:
deadlinecommand -GetJobSetting <Job ID> <Extra Setting> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
<Job Setting> |
The Job setting |
SetJobSetting¶
Description:
Sets the value of a setting for the Job.
Syntax:
deadlinecommand -SetJobSetting <Job ID(s)> <Job Setting> <Value> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
<Job Setting> |
The Job setting |
<Value> |
The new value |
SetJobFrameRange¶
Description:
Modifies the Job’s frame range.
Syntax:
deadlinecommand -SetJobFrameRange <Job ID(s)> <Frame List> <Chunk Size> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
<Frame List> |
The new frame list |
<Chunk Size> |
The new chunk size |
SetJobMachineLimit¶
Description:
Sets the machine limit for the Job.
Syntax:
deadlinecommand -SetJobMachineLimit <Job ID(s)> <Limit> <Listed> <Whitelist Flag> [<Limit Progress>] |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
<Limit> |
The new limit |
<Listed> |
The listed Workers |
<Whitelist Flag> |
true/false |
<Limit Progress> |
The limit progress (optional) |
SetJobMachineLimitListedSlaves¶
Description:
Sets the Job’s listed Workers.
Syntax:
deadlinecommand -SetJobMachineLimitListedSlaves <Job ID(s)> <Workers> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
<Workers> |
The Workers, separated by commas |
SetJobMachineLimitMaximum¶
Description:
Sets the Job’s machine limit.
Syntax:
deadlinecommand -SetJobMachineLimitMaximum <Job ID(s)> <Limit> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
<Limit> |
The machine limit |
SetJobMachineLimitReleaseProgress¶
Description:
Sets the Job’s machine limit progress.
Syntax:
deadlinecommand -SetJobMachineLimitReleaseProgress <Job ID(s)> <Limit Progress> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
<Limit Progress> |
The limit progress |
SetJobMachineLimitWhiteListFlag¶
Description:
Sets the Job’s whitelist flag.
Syntax:
deadlinecommand -SetJobMachineLimitWhiteListFlag <Job ID(s)> <Whitelist> |
Arguments:
Argument |
Description |
|---|---|
<Job ID(s)> |
The Job ID, or a list of Job IDs separated by commas |
<Whitelist> |
True/False |
UpdateJobSubmissionDate¶
Description:
Updates the Job submission date for the specified Job to be the current date.
Syntax:
deadlinecommand -UpdateJobSubmissionDate <Job ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The Job ID |
Job Submission and Rendering¶
SubmitBackgroundJob¶
Description:
Submits a Job as a background process.
Alias: Background
Syntax:
deadlinecommand -SubmitBackgroundJob <notify> <Job Files> |
deadlinecommand -Background <notify> <Job Files> |
Arguments:
Argument |
Description |
|---|---|
<notify> |
This flag displays a notification window after the Jobs have been submitted |
<Job Files> |
The list of Job files |
PluginSubmissionInfoFromJob¶
Description:
Generates a list of Plugin Submission Parameters that can be used to submit a similar Job to the one provided.
Syntax:
deadlinecommand -PluginSubmissionInfoFromJob <Job ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The ID of the Job on which to base the Plugin Submission Parameters. |
JobSubmissionInfoFromJob¶
Description:
Generates a list of Job Submission Parameters that can be used to submit a similar Job to the one provided.
Syntax:
deadlinecommand -JobSubmissionInfoFromJob <Job ID> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The ID of the Job on which to base the Job Submission Parameters. |
GenerateSubmissionInfoFiles¶
Description:
Generates a Job Info file and a Plugin Info file that can be used to submit a new Job, based on an existing one.
Syntax:
deadlinecommand -GenerateSubmissionInfoFiles <Job ID> <Job Info File> <Plugin Info File> |
Arguments:
Argument |
Description |
|---|---|
<Job ID> |
The ID of the Job on which to base the Submission Parameters. |
<Job Info File> |
The file to which the Job Submission Info will be output. |
<Plugin Info File> |
The file to which the Plugin Submission Info will be output. |
GetSubmissionInfo¶
Description:
Displays common submission information that can be used by Job submission scripts.
Syntax:
deadlinecommand -GetSubmissionInfo <Type(s)> |
Arguments:
Argument |
Description |
|---|---|
<Type(s)> |
A list of specific submission information. Each type should be separated by a space.
The available types are:
|
SubmitCommandLineJob¶
Description:
Submits a generic command line Job to Deadline. The <STARTFRAME> and <ENDFRAME> strings in the command line arguments will be replaced with the actual start and end frame for each task. The <QUOTE> string in the command line arguments will be replaced with a ‘”’ character.
Syntax:
deadlinecommand -SubmitCommandLineJob <executable <Value>> [arguments <Value>] <frames <Value>> [chunksize <Value>] [pool <Value>] [group <Value>] [priority <Value>] [name <Value>] [department <Value>] [initialstatus <Value>] [prop <Key=Value>] |
Arguments:
Argument |
Description |
|---|---|
<executable <Value>> |
Required: The command line executable. |
<arguments <Value>> |
Optional: The command line arguments. |
<frames <Value>> |
Required: The frame range to render. |
<chunksize <Value>> |
Optional: The task chunk size. |
<pool <Value>> |
Optional: The pool the Job belongs to. |
<group <Value>> |
Optional: The group the Job belongs to. |
<priority <Value>> |
Optional: The Job priority (0 is the lowest). |
<name <Value>> |
Optional: The Job name. |
<department <Value>> |
Optional: The Job department. |
<initialstatus <Value>> |
Optional: The Job’s initial state (Active/Suspended). |
<prop <Key=Value>> |
Optional: Extra submission properties in the form Key=Value. |
SubmitJobAndNotify¶
Description:
Submits a Job and notifies upon completion.
Syntax:
deadlinecommand -SubmitJobAndNotify <deleteFiles> <Job Files> |
Arguments:
Argument |
Description |
|---|---|
<deleteFiles> |
Specify this flag to delete local files after submission |
<Job Files> |
The Job files |
Notify¶
Description:
Submits a Job and notifies upon completion.
Syntax:
deadlinecommand -Notify <drop> <notify> <deleteFiles> |
Arguments:
Argument |
Description |
|---|---|
<drop> |
Specify this flag to do a drop Job |
<notify> |
Specify this flag to display a notification when submission completes |
<deleteFiles> |
Specify this flag to delete local files after submission |
SubmitMultipleJobsV2¶
Description:
SubmitMultipleJobsV2 is a new command for the submission of multiple jobs to Deadline, at the same time. Compared to SubmitMultipleJobs, SubmitMultipleJobsV2 allows the submission of complex dependency structures - that is submissions with jobs dependencies both on already existing jobs and on jobs already part of the submission. The new command minimizes the number of requests and responses needed to submit multiple jobs, resulting in better overall performance.
SubmitMultipleJobsV2 requires the Deadline Client to be connected to the Repository using the Remote Connection Server.
Syntax:
deadlinecommand -SubmitMultipleJobsV2 <JSON File Path> <Max Aux File Batch Size in MB> |
Arguments:
Argument |
Description |
|---|---|
<JSON File Path> |
Required: The path to a file containing the definition for the job submission. |
<Max Aux File Batch Size in MB> |
Optional: How large should each chunk of an aux file be when uploading. (Defaults to 1MB) |
Example Json File:
The JSON structure contains a Jobs field, which is an array of jobs. Each job should have the following fields:
JobInfoFilePath - job path;
PluginInfoFilePath - plugin information;
JobDependencies - a list describe jobs on which a job depends on;
AuxiliaryFiles - a list of job’s auxiliary files.
Note that JobDependencies in the following can be set to null, or a list of existing jobs using the jobId:// prefix followed by the ID of a job already in Deadline. Additionally, jobs in the current submission - which don’t yet have an ID - can be referred by their position in the list of jobs using the index:// syntax. Indexation starts with 0, making the first job index index://0.
{
"Jobs": [
{
"JobInfoFilePath":"/path/to/job_1_info_file.txt",
"PluginInfoFilePath":"/path/to/job_1_plugin_file.txt",
"JobDependencies":null,
"AuxiliaryFiles":[
"/path/to/aux_file_1.ext",
"/path/to/aux_file_2.ext",
]
},
{
"JobInfoFilePath":"/path/to/job_2_info_file.txt",
"PluginInfoFilePath":"/path/to/job_2_plugin_file.txt",
"JobDependencies":[
"index://0",
"jobId://6140bf0ddc2a9267443e5778",
"jobId://6140be77841dc62b94d05cc2"
]
"AuxiliaryFiles":[
"/path/to/aux_file_1.ext",
"/path/to/aux_file_2.ext",
]
},
{
"JobInfoFilePath":"/path/to/job_3_info_file.txt",
"PluginInfoFilePath":"/path/to/job_3_plugin_file.txt",
"JobDependencies":[
"index://0",
"index://1"
]
"AuxiliaryFiles":[
"/path/to/aux_file_3.ext",
"/path/to/aux_file_4.ext"
]
}
]
}
SubmitMultipleJobs¶
Description:
Note: For more flexible job submissions, it is recommended to use SubmitMultipleJobsV2 command instead.
Submits multiple Jobs at once.
Alias: Multi
Syntax:
deadlinecommand -SubmitMultipleJobs <dependent> <notify> <job <Job Files>> |
deadlinecommand -Multi <dependent> <notify> <job <Job Files>> |
Arguments:
Argument |
Description |
|---|---|
<dependent> |
This flag makes each Job in the list of Jobs specified dependent on the previous Job. This is shorthand for specifying -dependsonprevious for each Job being submitted |
<notify> |
This flag displays a notification window after the Jobs have been submitted |
<job <Job Files>> |
This flag must precede each list of files for each individual Job being submitted. You can also add the -dependsonprevious flag to make a single Job dependent on the previous Job |
RenderJob¶
Description:
Renders a Job immediately on the local machine without submitting it to the Repository.
Syntax:
deadlinecommand -RenderJob <JobInfoFile> <PluginInfoFile> <Auxiliary Files> |
Arguments:
Argument |
Description |
|---|---|
<JobInfoFile> |
The Job info file |
<PluginInfoFile> |
The plugin info file |
<Auxiliary Files> |
Additional optional files to submit with the Job (specify each file as a separate argument) |
