Command Line Job Submission

Command line job submission applications are available for both the Windows and Mac platform.  On the Mac, the application must be downloaded separately from the GUI agent.  On Windows, the console application is downloaded and kept up to date as part of the install/update procedure.  The command line application on both platforms requires the GUI agent on the same machine, so it can not be run on a system that does not have a configured and running agent.  The only functions the console application currently enables is the submission of jobs.  Job file compression, data transfer, and management is all performed by the GUI agent.

Running console.exe or console from the command line with no options gives you the help output:

usage: console.exe [-h] –command [{submit}] –scenefile [SCENEFILE]
[{3D Studio Max 2015,3D Studio Max 2016,AfterEffects 2014,Arnold 4,Blender 2.7,Cinema4D R16,Cinema4D R17,Lightwave 11,Lightwave 2015,LuxRender 1.4,LuxRender 1.5,Maxwell 3,Maya 2015,Maya 2016,Modo 902,Softimage 2015,Terragen 2.5,Terragen 3.4,Terragen Alpha,Vue 2015}]
[–framelist [FRAMELIST]] [–giframelist [GIFRAMELIST]]
[–outputfolder [OUTPUTFOLDER]] [–outputname [OUTPUTNAME]]
[–outputformat [OUTPUTFORMAT]] [–budget [BUDGET]]
[–hres [HRES]] [–vres [VRES]]
[–renderorder [{sequential,random}]] [–power [POWER]]
[–nowarn] [–autopower] [–camera [CAMERA]]
[–downloadall] [–email [EMAIL]]
console.exe: error: argument –command is required


Typical of other command line applications, you must enclose strings that contain space characters with quotes (like the renderapp strings), and an error with job submission results in a non-zero exit code.  We’ve made efforts to make the console applications as easy to use as our GUI agent, so many of the settings are not required provided they have been defined previously by either console or GUI job submission.  Examples of this would be the notification email address.  If you’ve used the installed agent to submit a job in the past, then an email address is already defined and doesn’t need to be specified on subsequent console application runs unless you desire to change the notification address.

Also similar to the GUI agent, not all of the strings are required for each application or job type.  For example, we do not require or request an output format definition for 3D Studio Max jobs, since we gather that from your scene file during the analysis pass.  Specifying an output format for a 3D Studio Max job, therefore, would be ignored.  Another example is the –camera switch, which is currently only applicable to Maya scene files.  We advise you to mock-submit your scene file using the GUI to see exactly what the agent will request in order to determine what you need to specify on the console.  This should be applicable in the future, as well, as we add features to the agent.

Below are a few examples of how to use the console application on Windows:

console –command submit –scenefile “C:\Users\john\Terragen test job\Open Water Animation Tests 3.tgd” –renderapp “Terragen 3.4” –framelist 1:100by5 –outputfolder c:\output –power 1 –email

console –command submit –scenefile “C:\Users\fred\Desktop\Animation\3dsmax test scene\_scene.max” –renderapp “3D Studio Max 2015” –framelist 1 –outputfolder “f:\fred’s files” –outputname foobar_test.png –power 3

console –command submit –scenefile “C:\Projects\Modo Car Animation\C9_Animation.lxo” –renderapp “Modo 902” –framelist 1:200 –outputfolder c:\Hi-def –power 6

As you can see from the examples above, we may not have specified an exact Power level that matches what is available in the GUI.  In that case, the agent rounds to the nearest Power level for you.  If you specify an exact Power level to the console application, like 8.8, it will be left untouched.


Facebook Icon Twitter Icon Visit Our Vimeo Page