14/11/11 Eyeon:Manual/Network Rendering/Console Slave - VFXPedia

1/5 www.vfxpedia.com/index.php?title=Eyeon:Manual/Network_Rendering/Co
Eeon:Manual/Network Rendering/Console
Slave
From VFXPedia
< Eyeon:Manual Network Rendering
Fusion 5.1 introduces the ConsoleSlave, a new command line style renderer that greatly simplifies integration
with these third party render managers.
Both the RenderSlave and the Console Slave are installed at the same time, and the executables are found in the
same folder on the system, which is usually C:\Program Files\Fusion Render Slave.
Contents
1 RenderSlave vs. ConsoleSlave
2 RenderTool Script
3 Common Usage
4 Commandline Arguments
4.1 [ filename.comp filename.dfq ]
4.2 [/config]
4.3 [/manager]
4.4 [/quiet]
4.5 [/clean]
4.6 [/about]
4.7 [/render [/frames <frameset>] [/start <frame>] [/end <frame>] [/step <step>]
4.8 [/frames <frameset>]
4.9 [/step <increment>]
4.10 [/quit]
4.11 [/status]
4.12 [/listen]
4.13 [/join <host>]
4.14 [/log filename]
4.15 [/cleanlog]
4.16 [/verbose]
4.17 [/quietlicense]
4.18 [/version]
4.19 [/pri highabovenormalbelowidle]
5 Exit Codes
RenderSlave vs. ConsoleSlave
RenderSlave.exe is a render-only license of Fusion designed for use with Fusion's native render manager. It is
designed to be used only with the render manager that ships with Fusion. Generally the RenderSlave is run at
14/11/11 Eyeon:Manual/Network Rendering/Console Slave - VFXPedia
2/5 www.vfxpedia.com/index.php?title=Eyeon:Manual/Network_Rendering/Co
system startup, and should remain open until the system is shut down.
ConsoleSlave.exe is a command line style version of the RenderSlave that was designed specifically to help
Fusion integrate with third party render managers such as Rush, Deadline, Qube, or other custom in-house
solutions. Typically the ConsoleSlave is run with command line arguments that describe the composition to be
rendered and the frame range which will be rendered. It outputs render messages to the system's standard
output (STDOUT), and exits automatically after the render is completed.
RenderTool Script
The Render Tool script used to integrate RenderSlave with third party Render Managers in previous versions of
Fusion is no longer recommended. eyeon Software strongly suggests use of the ConsoleSlave in facilities where
RenderTool.eyeonscript or a variation were in use.
Common Usage
The most common use of ConsoleSlave would be to render a subset of a composition's render range under the
direction of a third party render manager. For example, to render frames 10-15 of x:\test.comp, you would run
the command:
consoleslave :\test.comp /start 10 /end 15
This would start the ConsoleSlave, load test.comp, render frames 10-15, then close the composition and exit
the renderslave. Any errors or problems would be logged to STDOUT, and can be piped to a file for later
analysis.
Commandline Arguments
Note : The ConsoleSlave shares the same commandline arguments used by the RenderSlave, however, it
will ignore some arguments, or some arguments are default on ConsoleSlave when they must be explicitly
specified on the RenderSlave.
Note : Hyphens may be used instead of slashes if you prefer, e.g. consoleslave -version
Running ConsoleSlave with no arguments, or with /? or /help, will display the help message:
ConsoleSlave.exe [<filename.comp> <filename.dfq>] [/config] [/manager] [/quiet]
[/clean] [/about] [/render [/frames <frameset>] [/start <frame>] [/end <frame>] [/step
<step>] [/quit]] [/status] [/listen] [/join <host>] [/log <filename>] [/cleanlog] [/verbose]
[/quietlicense] [/version] [/pri highabovenormalbelowidle]
[ filename.comp filename.dfq ]
The first argument for the console slave is usually the full path to the file which is to be rendered. While this will
typically be the path to a composition, it can also be a queue (.dfq) saved from the Fusion Render Manager.
Path maps are allowed, as specified in the console slave's preferences, and environment variables (in $(var)
format) will be expanded as well.
[/config]
14/11/11 Eyeon:Manual/Network Rendering/Console Slave - VFXPedia
3/5 www.vfxpedia.com/index.php?title=Eyeon:Manual/Network_Rendering/Co
RedeSae . Whe he /cfig age i ecified, he ae i e he Pefeece diag afe
aig.
/manager]
RedeSae . Whe he /aage age i ecified, he ae i e he Rede Maage diag
afe aig.
/quiet]
RedeSae.ee e hi age e a aig ad e diag ha eie e
ieaci, ad igh ee he ae f aig hig d. The /ie age i eabed b
defa he CeSae, ad ha effec if ecified he cadie.
/clean]
RedeSae . Thi i ee he RedeSae f diaig a ah cee a. Thi i i
eabed b defa he CeSae, ad ha effec if ecified he cadie.
/about]
RedeSae . Whe he /ab age i ecified, he ae i e a Ab diag afe aig.
/render /frames <frameset>] /start <frame>] /end <frame>] /step <step>]
The /ede age e he ae ede he cii ee ided a he fi age. The
/a ad /ed age ca be ed eide he ede age ed i he cii. If he /ede
age i accaied ih a /a ad /ed fae he he CeSae i ede he ede age
ed i he cii. Ne ha, f CeSae, he /ede, /a ad /ed age ae ia, if a
c fieae i ecified. F eae, he fig ie ae eiae:
consoleslave :\test.comp /render /start 10 /end 15
consoleslave :\test.comp 10 15
/frames <frameset>]
The /fae age ca be ed i ace f he /a ad /ed age ecif a -cig fae
age. The faee hd be ecified ig he ae e eed ecif faee i Fi ede
eig diag. Secifica, eeia age hd be decibed ig eid (..), ad idiida fae
hd be eaaed b ca. N ace ae aed beee F eae, he fig i a aid
faee.
consoleslave eample.comp /render /frames 1..10,15,25,30..50
/step <increment>]
The e age ca be ed i addii a fae age ic he edee ede ee 'icee'
14/11/11 Eyeon:Manual/Network Rendering/Console Slave - VFXPedia
4/5 www.vfxpedia.com/index.php?title=Eyeon:Manual/Network_Rendering/Co
be f fae. F eae, ede ee 3d fae f a cii' ede age:
consoleslave eample.comp /render /step 3
[/i]
The /i age if he ae ei afe edeig he ecified cii. Thi i he defa behai
f he CeSae, he a cii fieae ha bee ided.
[/a]
Rede Sae . Whe he /a age i ecified, he ae i e he Rede Sa diag afe
aig.
[/lien]
CeSae . Ue he /ie age ach he CeSae i Lie de, ad ee i f
eiig. N cii eed be ecified he hi age i ed. Thi ca be ef cicae
ih i ih a ci, f e ieaci ia he e a ic (e.g. chage efeece).
[/join <ho>]
Rede Sae . Ue he /ji age eide he Fi ede aage ecified b he ae
efeece. The ae i a ad ed a iga he ecified h aage idicae ha i i
aaiabe f edeig.
[/log filename]
Ue he /g age ecif a aeae fieae f he g fie, ahe ha he defa Rede.g.
[/cleanlog]
Ue he /ceag age cea he ce Rede.g fie, ahe ha aedig i.
[/eboe]
Thi age i ed dce a Vebe g ih ea behig daa, ch a iig a g-i a
he ae a aded.
[/ielicene]
RedeSae . The /ieicee age ee he dia f a diag he he ae fai
bai a icee, aig i fai ie ad e a e cde. Thi i i eabed b defa he
CeSae, ee e ieaci.
[/eion]
14/11/11 Eyeon:Manual/Network Rendering/Console Slave - VFXPedia
5/5 www.vfxpedia.com/index.php?title=Eyeon:Manual/Network_Rendering/Co
Thi i dia he ei, bid be ad bid dae f he eecabe, he ei.
[/pri highabovenormalbelowidle]
The /i i ca be ed ecif he ii f he ae ce he ai. A ii f 'high'
ide e e ece he ce a he eee f he cee ig he e. A
ii f 'ide' i acae e ece he ae he he cee eie he.
Exit Codes
The CeSae dce a eic ei cde he i cee, hich ca be checed i a bach fie b
a hid-a ede aage. The fig ei cde ae c:
0 ea ha he ede he eai ceed ccef, ad CeSae eied a.
10 ea hee a a be ih edeig he c (ee he ede g f deai), ha he
ce a ieed b a CTRL-C iga.
20 ea hee a e be ih he a - DLL a be iig, a be ih a gi
a eceed, hee a a be baiig a icece. Chec he ce ae' , e-
i ih he /ebe ich f e ifai.
Reieed f "h://.fedia.c/ide.h?ie=Ee:Maa/Ne_Redeig/Ce_Sae"
Thi age a a dified 13 Decebe 2006, a 03:24.