Command line usage

Muster Dispatcher and Renderclient service can be launched from the command lines for debugging purposes, or under certain circumstances, if you need to start processes that uses your graphic card and they do not support running as a system service, you'll need to start the Renderclient as a console application.

This is a list of the flags supported:

-licQuery for the host id required for licensing
-c [file]Read the configuration from an alternate file
-v [0/4]Specify the verbose level
-logfileRedirect log output to a file
-logstdioRedirect log output to stdio
-lognoneDisable the log
-lognostdio Disable stdio log
-logoutf [file]Specifies the log file
-logoutp [path]Specified the log output path

Windows flags

-sRun as a system service
-installInstall the executable in the SCM
-removeRemove the executable from the SCM
-svcuserUser to assign to the Service
-svcpasswordPassword for the user to assign to the Service

Linux/Mac flags

-dRun as a daemon, fork a copy of self then return to caller
-lsyslogRedirect log output to syslog
-lidentity [STRING]Specifies the syslog identity
-lfacility [0-7]Specifies the syslog facility

Dispatcher only

-reindexRebuild the databases indexes

Also, each service looks up for a MUSTER9 environmental variable that may be used to specify a different location for the Python library and templates contents.

Muster Console can be launched from the command lines to automate the connection task. It also supports several flags with different meanings:

-forcegl2Forces OpenGL 2.1 on Images viewer
-connectEnables auto connection
-serverDispatcher service IP address
-userUsername
-passPassword
-portDispatcher service socket port
-filterNetwork flow filter
-skipdirectoryauthSkips directory authentication
-allowmultipleinstancesLet you launch multiple Console instances
-openviewerLaunches the image viewer in disconnected modes and tries to open the image file on the next parameter
-templatesdirSpecifies a different path to look up for templates, in that case, no update of the templates files is done unless you specify -enabletemplatespathstorage
-templatespathSame as -templatesdir
-enabletemplatespathstorageAllows storage of updated templates files
-extraparampresetspathLooks up for additional parameters presets files from a different path. It disables storage of the presets on this file unless you specify -enableextraparamstorage
-enableextraparamstorageAllows storage of additional parameters
-skinspathLooks up for additional skips from a different path. It disables storage of the skins on this file unless you specify -enableskinsstorage
-enableskinsstorageAllows storage of skins
-presetspathLooks up for presets files from a different path. It disables storage of the presets on this file unless you specify -enablepresetsstorage
-enablepresetsstorageAllows storage of presets
-configpresetspathLooks up for configuration presets files from a different path. It disables storage of the presets on this file unless you specify -enableconfigpresetsstorage
-enableconfigpresetsstorageAllows storage of config presets
-workspacespathLooks up for workspaces files from a different path. It disables workspaces modification on this file unless you specify -enableworkspacesstorage
-enableworkspacesstorageAllows storage of workspaces
-scriptspathLooks up for scripts files from a different path. It disables scripts modification on this file unless you specify -enablescriptsstorage
-enablescriptsstorageAllows storage of scripts
-alarmspathLooks up for alarms configuration files from a different path. It disables alarms configuration unless you specify -enablealarmsstorage
-enablealarmsstorageAllows storage of alarms

Muster Console also supports several environmental variables:

  • MUSTER9: Specifies the location of the templates and the Muster Python distribution
  • MUSTEREXTRAPARAMPRESETSPATH: Same as -extraparampresetspath
  • MUSTERENABLEEXTRAPARAMSSTORAGE: Same as -enableextraparamstorage
  • MUSTERSKINSPATH: Same as -skinspath
  • MUSTERENABLESKINSSTORAGE: Same as -enableskinsstorage
  • MUSTERPRESETSPATH: Same as -presetspath
  • MUSTERENABLEPRESETSSTORAGE: Same as -enablepresetsstorage
  • MUSTERCONFIGPRESETSPATH: Same as -configpresetspath
  • MUSTERENABLECONFIGPRESETSSTORAGE: Same as -enableconfigpresetsstorage
  • MUSTERWORKSPACEPATH: Same as -workspacespath
  • MUSTERENABLEWORKSPACESTORAGE: Same as -enableworkspacesstorage
  • MUSTERSCRIPTSPATH: Same as -scriptspath
  • MUSTERENABLESCRIPTSSTORAGE: Same as -enablescriptsstorage
  • MUSTERALARMSPATH: Same as -alarmspath
  • MUSTERENABLEALARMSSTORAGE: Same as -enablealarmsstorage

Mrtool has a more complex list of flags. This is a resume, we suggest to check the latest version running mrtool –h for the flag list.

General flags

-versionShow version number and exit
-sDispatcher server name or ip address
-portDispatcher server socket port
-uUsername
-pPassword
-skipdirectoryauthSkips directory server authentication
-waitdbflushAfter performing an operation, waits until the changes are flushed to the Database
-templatesdirSpecify a different directory to read/write templates for the current session
-usecacheSkips templates synchronization with the Dispatcher and uses the local cache, if you're sure the templates are up to date, this will start mrtool faster than in the regular way. This is the suggested way to start mrtool in batch mode.

Local control mode

-eevSend an enable control event to the local client (supported on Windows only)
-devSend a disable control event to the local client (supported on Windows only)

Control mode

When controlling nodes/instances and jobs you can use multiple values in the [IDs] fields by separating multiple IDs with a comma (i.e. -cpup 1,2)

-chp [STRING]Change account password
-dsrSoft restart Dispatcher service
-rscReset Dispatcher statistics counters
-cdsChange dispatcher selection logic status
-py [s]Runs a python command on the Dispatcher
-pyf [s]Run a python file on the Dispatcher
-cpup [IDs]Pause node instance(s)
-cpur [IDs]Resume node instance(s)
-cpukg [IDs]Kill and go on node instance(s)
-cpukp [IDs]Kill and pause node instance(s)
-cpukr [IDs]Kill and redo node instance(s)
-cpukpjob [IDs]Kill and pause node instance(s) working on a specific job
-cpukrjob [IDs]Kill and redo node instance(s) working on a specific job
-cpukgjob [IDs]Kill and go on node instance(s) working on a specific job
-cpunote [IDs] [s]Change notes of a node instance(s)
-cpusr [IDs]Soft restart node instance(s), affects all the node's instances
-jobp [IDs]Pause job(s)
-jobr [IDs]Resume job(s)
-jobpon [IDs] [TIME]Pause job(s)at the specified time (time_c value)
-jobron [IDs] [TIME]Resume job(s)at the specified time (time_c value)
-jobston [IDs] [TIME]Set the starting time of the job(s) (time_c value)
-jobri [IDs]Reinit job(s)
-jobrn [IDs] [s]Rename job(s)
-jobpr [IDs] [n]Change priority of job(s)
-jobemergency [IDs] [0/1]Change emergency queue of job(s)
-jobpo [IDs] [s]Change included pools of job(s)
-jobpox [IDs] [s]Change job(s) excluded pools
-jobmn [IDs] [n]Change max nodes of job(s)
-jobdp [IDs] [n]Change dependence of job(s)
-jobdpmode [IDs] [n]Change dependence mode of job(s)(0 - Successes, 1 - Warnings, 2 - Errors)
-jobdplinkmode [IDs] [n]Change dependencies link mode of job(s)(0 - Jobs, 1 - Chunks)
-jobnt [IDs] [s]Change notes of job(s)
-jobpa [IDs] [ID]Change parent of job(s)
-jobproj [IDs] [s]Change project of job(s)
-jobdep [IDs] [s]Change department of job(s)
-jobrm [IDs]Delete job(s)
-jobown [IDs] [s]Change owner of job(s)
-joben [IDs] [n]Change engine of job(s)
-jobcto [IDs] [n] [1/0]Set job(s) override chunk timeout
-jobmro [IDs] [n] [1/0]Set job(s) override maximum chunk requeue count
-jobnmjl [IDs] [n] [1/0]Set job(s) override mail notifications at job level
-jobnmcl [IDs] [n] [1/0]Set job(s) override mail notifications at chunk level
-jobnnjl [IDs] [n] [1/0]Set job(s) override notificator notifications at job level
-jobnncl [IDs] [n] [1/0]Set job(s) override notificator notifications at chunk level
-jobnpjl [IDs] [n] [1/0]Set job(s) override mobile notifications at job level
-jobnpcl [IDs] [n] [1/0]Set job(s) override mobile notifications at chunk level
-jobnmjsl [IDs] [n] [1/0]Set job(s) start override mail notifications at job level
-jobnmcsl [IDs] [n] [1/0]Set job(s) start override mail notifications at chunk level
-jobnnjsl [IDs] [n] [1/0]Set job(s) start override notificator notifications at job level
-jobnncsl [IDs] [n] [1/0]Set job(s) start override notificator notifications at chunk level
-jobnpjsl [IDs] [n] [1/0]Set job(s) start override mobile notifications at job level
-jobnpcsl [IDs] [n] [1/0]Set job(s) start override mobile notifications at chunk level
-jobmlu [IDs] [n] [1/0]Set job(s) minimum logical units status and value
-jobmc [IDs] [n] [1/0]Set job(s) minimum cores status and value
-jobmpu [IDs] [n] [1/0]Set job(s) minimum physical units status and value
-jobmcs [IDs] [n] [1/0]Set job(s) minimum cores speed status and value
-jobmra [IDs] [n] [1/0]Set job(s) minimum ram amount status and value
-jobmdsa [IDs] [n] [1/0]Set job(s) minimum disk space status and value
-jobpvec [IDs] [s] [1/0]Set job(s) valid exit codes status and value
-jobpwec [IDs] [s] [1/0]Set job(s) warning exit codes status and value
-jobpeec [IDs] [s] [1/0]Set job(s) error exit codes status and value
-jobpvlt [IDs] [s] [1/0]Set job(s) valid log texts status and value
-jobpwlt [IDs] [s] [1/0]Set job(s) warning log texts status and value
-jobpelt [IDs] [s] [1/0]Set job(s) error log texts status and value
-jobattrib [IDs] [ATTRIB] [s] [1/0]Set job(s) attribute status and value
-lock [IDs]Lock job(s)
-unlock [IDs]Unlock job(s)
-archive [IDs]Archive job(s)
-unarchive [IDs]Unarchive job(s)
-jobrestore [IDs]Restore the supplied backup job(s) IDs (comma separated)
-jobrestorerm [0/1/2]Specifies the parent mode of a restore operation (0 - None, 1 - Restore parents , 2 - Reparent)
-jobrestoreom [0/1/2]Specifies the overwrite mode of a restore operation (0 - None, 1 - Overwrite existings , 2 - Duplicate)
-jobrestorepid [ID]Specified the new parent ID if reparent is selected for a restore operation
-jobbackup [IDs]Backups the specified job(s) IDs (comma separated)
-jobbackupdelete [ID]Backups and delete the specified job(s) IDs (comma separated)
-jobbackupmode [ID]Specifies the overwrite mode of a restore operation (0 - None, 1 - Overwrite existings , 2 - Duplicate)
-backupremovejobs [IDs]Removes the specified backup job(s) IDs from the backup database
-chunkrq [JOBID] [IDs]Requeue given chunks
-chunkdn [JOBID] [IDs]Set given chunks to complete
-chunkrsrq [JOBID] [IDs]Reset given chunks requeue counter

Query mode

-q [cjhplstban]Query mode
cQuery nodes
jQuery jobs
hQuery chunks
pQuery pools
lQuery logs
sQuery statistics
tQuery templates
bQuery backup boundaries
aQuery all
nQuery none
-backup [START TIME] [END TIME] [TEMPLATEID] [JOBID] [JOBNAME] [OWNER]Gets a list of available backup jobs using the supplied filters
-job [ID]Job id to query
-qarc [n]Query unarchivied (0), archivied(1) or both(2)
-jobparent [ID]Limit query to a specific folder
-jobstatus [n]Limit query to a specific status
-jobengine [n]Limit query to a specific engine
-templfields [ID]Dumps template required fields
-templversions [ID]Dumps template supported versions
-cpu [ID]Node id to query
-cpustatus [n]Limit query to a specific status
-cpuos [n]Limit query to a specific OS
-chunk [ID]Chunk id to query
-jf [#,#,…]Reformat job fields
idJob ID
fileJob file
contentpathJob content path
projectJob content path
departmentJob department
output_folderJob output path
parentJob parent ID
dependJob depend IDs
dependmodeJob depend mode
typeJob type
priorityJob priority
statusJob status
lockedJob locked status
progressJob progress
pktypePacket type
taskmaskTasks mask
pksizePacket size
engineJob template
maxcpuMax allowed nodes
workingcpuNodes working on job
requeuedNumber of requeues
ecerrchecktypeType of error checking for exit codes
logerrchecktypeType of error checking for logs texts
nameName
poolPools
excludepoolExcluded pools
ownerJob owner
subtmSubmission time
startStarting time
endEnding time
totaltTotal processing time
pausedPaused flag
archivedArchivied flag
pauseonPauses at time
resumeonResumes at time
startonStarts at time
indentJob indent level
updatetimeJob last update time
exitcodeerrchecktypeExit codes error check type
logserrchecktypeLogs error check type
mailnotjobtypeMail notifications at job level type
ovrmailnotchunkOverrides mail notifications at chunk level
mailnotchunktypeMail notifications at chunk level type
ovrnotnotjobOverrides notificator notifications at job level
notnotjobtypeNotificator notifications at job level type
ovrnotnotchunkOverrides notificator notifications at chunk level
notnotchunktypeNotificator notifications at chunk level type
ovrmobnotjobOverrides mobile notifications at job level
mobnotjobtypeMobile notifications at job level type
ovrmobnotchunkOverrides mobile notifications at chunk level
mobnotchunktypeMobile notifications at chunk level type
ovrjobcheckOverrides frame check
ovjchunkcheckOverrides chunks check
ovrchunktimeoutOverrides chunks timeout
ovrjobcheckvalueOverrides job check value
ovjchunkcheckvalueOverrides chunks check value
ovrjobchecktypeOverrides job check type
ovrchunkchecktypeOverrides chunk check type
ovrmailaddressOverridden mail address
ovrchunkstimeoutOverridden chunks timeout
overrideValidExitCodesOverride valid exit codes
overrideWarningExitCodesOverride warning exit codes
overrideErrorExitCodesOverride error exit codes
overrideMinimumThreadsJob minimum required threads
overrideMinimumCoresJob minimum required core
overrideMinimumPhysicalJob minimum physical cores
overrideMinimumSpeedJob minimum cores speed
overrideMinimumRamJob miminum ram
overrideMinimumDiskSpaceJob minimum disk space
overrideMaximumChunksRequeueOverride job maximum chunks requeue
overrideWarningExitCodesValueOverride warning exit codes
overrideErrorExitCodesValueOverride error exi
overrideMinimumThreadsValueJob minimum required threads
overrideMinimumCoresValueJob minimum required cores
overrideMinimumPhysicalValueJob minimum physical
overrideMinimumSpeedValueJob minimum cores speed
overrideMinimumRamValueJob mininum ram value
overrideMinimumDiskSpaceValueJob minimum disk
overrideMaximumChunksRequeueValueOverride job
sfJob starting frame
efJob ending frame
bfJob by frame
stepJob step by
nbJob number by
digitsJob frame digits
xresJob X resolution (SF)
yresJob Y resolution (SF)
overlapJob AS overlap (SF)
ratioJob image ratio (SF)
#####Custom attribute
-cf [#,#,…]Reformat cpu fields
idNode ID
osNode system
nameNode name
numNode number of cpus
ipNode IP address
sstNode render status
cpuusageNode cpus usage
ramusageNode ram usage
ppriorityNode spawned process priority
jobidCurrent job ID
chunkidCurrent chunk ID
statusNode status
tpauseScheduled pause flag
jobnameNode active job name
chunknamefNode active chunk frame range
chunknameNode active chunk frame range[integer numbers]
priorityNode priority
rtlogNode real time log flag
notesNode notes
wpauseNode will pause
suptempSupported templates
macNode mac addresses
cmdlineHost current command line
progressJob total progress
physcoretypeNode physical cores types
physcorespeedNode physical cores speed
physccountNode physical cpus count
physcorecountNode physical cores count
diskarrayNode disks array status
platdescNode platform description
affinityNode process affinity mask
updatetimeNode last update time
-hf [#,#,…]Reformat chunk fields
idChunk ID
statusChunk status
requeuedChunk requeue counter
sfChunk start frame
efChunk end frame
bfChunk by frame
stChunk starting time
etChunk ending time
elapsedChunk elapsed time
renderbyChunk assigned host
resultChunk results
-lf [#,#,…]Reformat log fields
typeLog type
timeLog time
ipLog source IP
hostLog source host
entryLog entry
userLog source user
-pf [#,#,…]Reformat pool fields
parentPool name
nameNode name
ip
-H [0/1]Headers output mode
-S [0/1]Separators output mode
-C [0/1]Resolve fields costants

Batch submission mode

-bBatch submit (Enables submission mode)
-folderCreate folder
-job [n]Job ID to edit
-e [n]Engine template ID (MANDATORY)
-tv [s]Engine template version
-n [s]Job name (MANDATORY)
-f [s]Job file (MAPS TO job_file VALUE)
-proj [s]Project path (MAPS TO job_project VALUE)
-project [s]Job project
-department [s]Job department
-shot [s]Job shot
-camera [s]Job camera
-sequence[s]Job sequence
-dest [s]Frames destination (MAPS TO output_folder VALUE)
-sf [n]Start frame (MAPS TO start_frame VALUE, MANDATORY on MULTIFRAME JOBS)
-ef [n]End frame (MAPS TO end_frame VALUE, MANDATORY on MULTIFRAME JOBS
-bf [n]By frame (MAPS TO by_frame VALUE)
-se [n]Starting numbering (MAPS TO number_by VALUE)
-st [n]Numbering step (MAPS TO step_by VALUE)
-range [s]Frames range in the form of 1-10x1n1s1 with comma separated values for multiple range. Overrides the -sf, -ef -bf -se -st flags
-target [s]Target host name/IP address (Mandatory for single host jobs, use * for any instance)
-max [n]Maximum instances
-pr [n]Priority
-pk [n]Packet size
-chpr [n]Chunks priority mode (0 - Ramp Down, 1 - Ramp up, 2 - Center up, 3, Center down, 4 - Interleave up, 5 - Interleave down9.0.1+
-chint [n]Chunks interleave amount9.0.1+
-emergency [0/1]Emergency priority queue
-add [s]Engine additional parameters
-pool [s]Destination pool(s)
-excludepool [s]Excluded pool(s)
-minthreads [d]Minimum instance logic threads
-mincores [d]Minimum instance physical cores
-minphysical [d]Minimum instance physical cpus
-minspeed [n]Minimum instance physical cores speed in GHz
-minram [n]Minimum instance available RAM in GBytes
-mindisk [n]Minimum instance available disk space in MBytes
-ecerrtype [n]Exit codes error check logic (0 - Default, 1 - Skip warnings, 2 - Skip errors, 3 - Skip both)
-logerrtype [n]Logs error check logic (0 - Default, 1 - Skip warnings, 2 - Skip errors, 3 - Skip both)
-parent [ID]Parent ID (ID must match a folder)
-wait [ID]Depends from a list of jobs (ID,ID,…)
-waitmode [n]Dependancies check mode (0 - Successes, 1 - Warnings, 2 - Errors)
-waitlinkmode [n]Dependancies link mode (0 - Job, 1 - Chunk)
-info [s]Additional information
-ojs [n]Override job status (0 - Disabled, 1 - Idle, 2 - Paused)
-attr [s] [s] [1/0]Custom attribute (Flag name - Flag value - Apply path substitution)
-framecheck [n]Activate frame check ( 0 - None, 1 - Scene, 2 - Chunk)
-expectedframes [s]Expected frames prefix (DEPRECATED use -framesmask instead)
-expectedmask [s]Expected prefix mask (DEPRECATED use -framesmask instead)
-framesmask [layername] [s]Expected frames output path mask, requires a layer name. May be invoked multiple times for multiple layers
-checkfiles [n]Check files sizes (0 - None, 1 - Exact , 2 - Limits)
-filelowlimit [n]Lowest file size
-filehighlimit [n]Highest file size
-recursion [n]Max recursion depth of requeue
-openimage [n]Attempt to open frames on frames check
-userenderlayers [n]Resubmit jobs for specific render layers only (must be template supported)
-checkdimensions [n]Checks the frames dimensions
-imagewidth [n]Expected frames width
-imageheight [n]Expected frames height
-ojmn [n]Override job mail notifications (0 - Disabled, 1 - Completed, 2 - Warnings only, 3 - Errors)
-ocmn [n]Override chunk mail notifications (0 - Disabled, 1 - Completed, 2 - Warnings only, 3 - Errors)
-ojnn [n]Override job notificator notifications (0 - Disabled, 1 - Completed, 2 - Warnings only, 3 - Errors)
-ocnn [n]Override chunk notificator notifications (0 - Disabled, 1 - Completed, 2 - Warnings only, 3 - Errors)
-ojpn [n]Override job mobile notifications (0 - Disabled, 1 - Completed, 2 - Warnings only, 3 - Errors)
-ocpn [n]Override chunk mobile notifications (0 - Disabled, 1 - Completed, 2 - Warnings only, 3 - Errors)
-ojsmn [n]Override job start mail notification (0 - Disabled, 1 - Enabled)
-ocsmn [n]Override chunk start mail notification (0 - Disabled, 1 - Enabled)
-ojsnn [n]Override job start notificator notification (0 - Disabled, 1 - Enabled)
-ocsnn [n]Override chunk start notificator notification (0 - Disabled, 1 - Enabled)
-ojspn [n]Override job start mobile notification (0 - Disabled, 1 - Enabled)
-ocspn [n]Override chunk start mobile notification (0 - Disabled, 1 - Enabled)
-oct [n]Override chunks timeout (value in minutes)
-omcr [n]Override maximum chunk requeue count
-ovex [s]Override valid process exit codes
-owex [s]Override warning process exit codes
-oeex [s]Override error process exit codes
-ston [TIME]Sets the starting time of the job
-pja [s]Pre-job action
-pjacrtDisable Pre-job action return code check
-pjart [n]Pre-job expected return code
-pjato [n]Pre-job action overriden timeout
-eja [s]Post-job action
-ejacrtDisable Post-job action return code check
-ejart [n]Post-job expected return code
-ejato [n]Post-job action overridden timeout
-pca [s]Pre-chunk action
-pcacrtDisable Pre-chunk action return code check
-pcart [n]Pre-chunk expected return code
-pcato [n]Pre-chunk action overriden timeout
-eca [s]Post-chunk action
-ecacrtDisable Post-chunk action return code check
-ecart [n]Post-chunk expected return code
-ecato [n]Post-chunk action overriden timeout

Single frame specific

-slc [n]Number of slices
-asv [n]Antialiasing overlap
-rat [n]Final image ratio (REQUIRED FOR Maya JOBS)
-iw [n]Final image width (MANDATORY on IMAGE SLICING JOBS)
-ih [n]Final image height (MANDATORY on IMAGE SLICING JOBS)
-isrc [s]Slices image format (Only for templates that specifies selectable formats)
-idst [s]Final image format (Only for templates that specifies selectable formats)
-skipassemblerSkip assembler chunk (manual slices management)

Broadcast specific

-si [1/0]Single instance mode

Single host specific

-target [s]Target host name/IP