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:

-lic	Query for the host id required for licensing
-c [file]	Read the configuration from an alternate file
-v [0/4]	Specify the verbose level
-logfile	Redirect log output to a file
-logstdio	Redirect log output to stdio
-lognone	Disable the log
-lognostdio	Disable stdio log
-logoutf [file]	Specifies the log file
-logoutp [path]	Specified the log output path

-s	Run as a system service
-install	Install the executable in the SCM
-remove	Remove the executable from the SCM
-svcuser	User to assign to the Service
-svcpassword	Password for the user to assign to the Service

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

-reindex	Rebuild 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:

-forcegl2	Forces OpenGL 2.1 on Images viewer
-connect	Enables auto connection
-server	Dispatcher service IP address
-user	Username
-pass	Password
-port	Dispatcher service socket port
-filter	Network flow filter
-skipdirectoryauth	Skips directory authentication
-allowmultipleinstances	Let you launch multiple Console instances
-openviewer	Launches the image viewer in disconnected modes and tries to open the image file on the next parameter
-templatesdir	Specifies a different path to look up for templates, in that case, no update of the templates files is done unless you specify -enabletemplatespathstorage
-templatespath	Same as -templatesdir
-enabletemplatespathstorage	Allows storage of updated templates files
-extraparampresetspath	Looks up for additional parameters presets files from a different path. It disables storage of the presets on this file unless you specify -enableextraparamstorage
-enableextraparamstorage	Allows storage of additional parameters
-skinspath	Looks up for additional skips from a different path. It disables storage of the skins on this file unless you specify -enableskinsstorage
-enableskinsstorage	Allows storage of skins
-presetspath	Looks up for presets files from a different path. It disables storage of the presets on this file unless you specify -enablepresetsstorage
-enablepresetsstorage	Allows storage of presets
-configpresetspath	Looks up for configuration presets files from a different path. It disables storage of the presets on this file unless you specify -enableconfigpresetsstorage
-enableconfigpresetsstorage	Allows storage of config presets
-workspacespath	Looks up for workspaces files from a different path. It disables workspaces modification on this file unless you specify -enableworkspacesstorage
-enableworkspacesstorage	Allows storage of workspaces
-scriptspath	Looks up for scripts files from a different path. It disables scripts modification on this file unless you specify -enablescriptsstorage
-enablescriptsstorage	Allows storage of scripts
-alarmspath	Looks up for alarms configuration files from a different path. It disables alarms configuration unless you specify -enablealarmsstorage
-enablealarmsstorage	Allows 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.

-version	Show version number and exit
-s	Dispatcher server name or ip address
-port	Dispatcher server socket port
-u	Username
-p	Password
-skipdirectoryauth	Skips directory server authentication
-waitdbflush	After performing an operation, waits until the changes are flushed to the Database
-templatesdir	Specify a different directory to read/write templates for the current session
-usecache	Skips 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.

-eev	Send an enable control event to the local client (supported on Windows only)
-dev	Send a disable control event to the local client (supported on Windows only)

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
-dsr	Soft restart Dispatcher service
-rsc	Reset Dispatcher statistics counters
-cds	Change 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

-q [cjhplstban]	Query mode
	c	Query nodes
	j	Query jobs
	h	Query chunks
	p	Query pools
	l	Query logs
	s	Query statistics
	t	Query templates
	b	Query backup boundaries
	a	Query all
	n	Query 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
	id	Job ID
	file	Job file
	contentpath	Job content path
	project	Job content path
	department	Job department
	output_folder	Job output path
	parent	Job parent ID
	depend	Job depend IDs
	dependmode	Job depend mode
	type	Job type
	priority	Job priority
	status	Job status
	locked	Job locked status
	progress	Job progress
	pktype	Packet type
	taskmask	Tasks mask
	pksize	Packet size
	engine	Job template
	maxcpu	Max allowed nodes
	workingcpu	Nodes working on job
	requeued	Number of requeues
	ecerrchecktype	Type of error checking for exit codes
	logerrchecktype	Type of error checking for logs texts
	name	Name
	pool	Pools
	excludepool	Excluded pools
	owner	Job owner
	subtm	Submission time
	start	Starting time
	end	Ending time
	totalt	Total processing time
	paused	Paused flag
	archived	Archivied flag
	pauseon	Pauses at time
	resumeon	Resumes at time
	starton	Starts at time
	indent	Job indent level
	updatetime	Job last update time
	exitcodeerrchecktype	Exit codes error check type
	logserrchecktype	Logs error check type
	mailnotjobtype	Mail notifications at job level type
	ovrmailnotchunk	Overrides mail notifications at chunk level
	mailnotchunktype	Mail notifications at chunk level type
	ovrnotnotjob	Overrides notificator notifications at job level
	notnotjobtype	Notificator notifications at job level type
	ovrnotnotchunk	Overrides notificator notifications at chunk level
	notnotchunktype	Notificator notifications at chunk level type
	ovrmobnotjob	Overrides mobile notifications at job level
	mobnotjobtype	Mobile notifications at job level type
	ovrmobnotchunk	Overrides mobile notifications at chunk level
	mobnotchunktype	Mobile notifications at chunk level type
	ovrjobcheck	Overrides frame check
	ovjchunkcheck	Overrides chunks check
	ovrchunktimeout	Overrides chunks timeout
	ovrjobcheckvalue	Overrides job check value
	ovjchunkcheckvalue	Overrides chunks check value
	ovrjobchecktype	Overrides job check type
	ovrchunkchecktype	Overrides chunk check type
	ovrmailaddress	Overridden mail address
	ovrchunkstimeout	Overridden chunks timeout
	overrideValidExitCodes	Override valid exit codes
	overrideWarningExitCodes	Override warning exit codes
	overrideErrorExitCodes	Override error exit codes
	overrideMinimumThreads	Job minimum required threads
	overrideMinimumCores	Job minimum required core
	overrideMinimumPhysical	Job minimum physical cores
	overrideMinimumSpeed	Job minimum cores speed
	overrideMinimumRam	Job miminum ram
	overrideMinimumDiskSpace	Job minimum disk space
	overrideMaximumChunksRequeue	Override job maximum chunks requeue
	overrideWarningExitCodesValue	Override warning exit codes
	overrideErrorExitCodesValue	Override error exi
	overrideMinimumThreadsValue	Job minimum required threads
	overrideMinimumCoresValue	Job minimum required cores
	overrideMinimumPhysicalValue	Job minimum physical
	overrideMinimumSpeedValue	Job minimum cores speed
	overrideMinimumRamValue	Job mininum ram value
	overrideMinimumDiskSpaceValue	Job minimum disk
	overrideMaximumChunksRequeueValue	Override job
	sf	Job starting frame
	ef	Job ending frame
	bf	Job by frame
	step	Job step by
	nb	Job number by
	digits	Job frame digits
	xres	Job X resolution (SF)
	yres	Job Y resolution (SF)
	overlap	Job AS overlap (SF)
	ratio	Job image ratio (SF)
	#####	Custom attribute
-cf [#,#,…]	Reformat cpu fields
	id	Node ID
	os	Node system
	name	Node name
	num	Node number of cpus
	ip	Node IP address
	sst	Node render status
	cpuusage	Node cpus usage
	ramusage	Node ram usage
	ppriority	Node spawned process priority
	jobid	Current job ID
	chunkid	Current chunk ID
	status	Node status
	tpause	Scheduled pause flag
	jobname	Node active job name
	chunknamef	Node active chunk frame range
	chunkname	Node active chunk frame range[integer numbers]
	priority	Node priority
	rtlog	Node real time log flag
	notes	Node notes
	wpause	Node will pause
	suptemp	Supported templates
	mac	Node mac addresses
	cmdline	Host current command line
	progress	Job total progress
	physcoretype	Node physical cores types
	physcorespeed	Node physical cores speed
	physccount	Node physical cpus count
	physcorecount	Node physical cores count
	diskarray	Node disks array status
	platdesc	Node platform description
	affinity	Node process affinity mask
	updatetime	Node last update time

-hf [#,#,…]	Reformat chunk fields
	id	Chunk ID
	status	Chunk status
	requeued	Chunk requeue counter
	sf	Chunk start frame
	ef	Chunk end frame
	bf	Chunk by frame
	st	Chunk starting time
	et	Chunk ending time
	elapsed	Chunk elapsed time
	renderby	Chunk assigned host
	result	Chunk results
-lf [#,#,…]	Reformat log fields
	type	Log type
	time	Log time
	ip	Log source IP
	host	Log source host
	entry	Log entry
	user	Log source user
-pf [#,#,…]	Reformat pool fields
	parent	Pool name
	name	Node name
	ip
-H [0/1]	Headers output mode
-S [0/1]	Separators output mode
-C [0/1]	Resolve fields costants

-b	Batch submit (Enables submission mode)
-folder	Create 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 down	9.0.1+
-chint [n]	Chunks interleave amount	9.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
-pjacrt	Disable 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
-ejacrt	Disable 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
-pcacrt	Disable 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
-ecacrt	Disable Post-chunk action return code check
-ecart [n]	Post-chunk expected return code
-ecato [n]	Post-chunk action overriden timeout

-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)
-skipassembler	Skip assembler chunk (manual slices management)

-si [1/0]	Single instance mode

-target [s]	Target host name/IP

Command line usage

Services

Windows flags

Linux/Mac flags

Dispatcher only

Console

Mrtool

General flags

Local control mode

Control mode

Query mode

Batch submission mode

Single frame specific

Broadcast specific

Single host specific

Muster 9+ Documentation