7 Local Command Line Interface

SquidNet’s “sqn” command line interface mimics all operations and options available in the main graphical user interface. Command line options are available in the following sections:

Tip

Use “sqn –help” command to list all available options. All options must be prefixed with “–“ (double-dash) characters


7.1 General Command Line Options

General Command Line Options
Command Line Option Description
appPathShow

Desciption

Displays application path profiles

Usage

Syntax: ... --appPathShow

Examples:

sqn --appPathShow
appProfileTemplateShow

Desciption

Displays application profiles associated with specified template.

Usage

Syntax: ... --appProfileTemplateShow <template-name>

Example: List all application profiles for 3DSMAX template.

sqn --appProfileTemplateShow 3dsmax

Note: To get list of application templates, use this command:

sqn --template all
aspectRatio

Desciption

Sets the image or video aspect ratio.

Usage

Syntax: ... --aspectRatio <16:9 or 4:3>

Example: Create MPEG4  videos with specified frame-rate, resolution and aspect-ratio.

sqn --video S:\Images\flames --videoOutputDir S:\Archives\Videos --videoFrameRate 29 --videoResolution 800x600 --aspectRatio 4:3 --codec mpeg4 --noWait
cancel

Desciption

Cancel job or transaction request.

Usage

Syntax: ... --cancel

Example: Cancelling a render job:

sqn --jobId #1324 --cancel

Example: Cancelling a transaction:

sqn --transactionId update-maya-install-base --cancel
cancelDependencies

Desciption

When canceling a job, also cancel any dependent jobs.

Usage

Syntax: ... --cancelDependencies

Example: Cancel job id maxJob#1 and also cancel any jobs that may be dependent on it:

sqn --jobId maxJob#1 --cancel --cancelDependencies
clearDependencies

Desciption

When canceling a job, prevent and child jobs from still being dependent on specified job.

Usage

Syntax: ... --clearDependencies

Example: Cancel job id maxJob#1 and clear any dependencies on it:

sqn --jobId maxJob#1 --cancel --clearDependencies
clientModeSet

Desciption

Sets the processing mode for SquidNet client nodes

Usage

Syntax: ... --clientModeSet <mode>

Possible options are:

    never:        Prevents node from rendering jobs.
    loggedout:    Only render jobs when all users are logged out.
    background:   Render when user is logged in but render at a very low CPU processing priority.
    screensaver:  Only render jobs when screen saver is running. (Mac OS only)

Example: Set all client nodes to render jobs at a low processing priority.

sqn --clientModeSet background --node clients

Example: Set client node RENDERNODE10 so that it only renders jobs when the screen saver is active (Mac OS only).

sqn --clientModeSet screensaver --node RENDERNODE10

Example: Set client node RENDERNODE10 so that it can never render jobs.

sqn --clientModeSet never --node RENDERNODE10
codec

Desciption

Codec to use when creating video from image sequences.

Usage

Syntax: ... --codec <h264 or mpeg4>

Example: Create MPEG4 videos with specified frame-rate, resolution and aspect-ratio:

sqn --video S:\Images\flames --videoOutputDir S:\Archives\Videos --videoFrameRate 29 --videoResolution 800x600 --aspectRatio 4:3 --codec mpeg4 --noWait
column

Desciption

Used on some CLI commands to only display specific columns.

Usage

Syntax: ... --column <list of columns>

Example: Only display Job id, frames, slices and owner columns for job queue listing.

sqn --jobQueueShow --column "Job Id",Frames,Slices,Owner
columnShow

Desciption

Display columns that could be displayed when using “–csv” option.

Usage

Syntax: ... --columnShow

Example:

sqn --jobHistoryShow --columnShow

Example:

sqn --renderFarmShow --columnShow

Example:

sqn  --jobQueueShow --columnShow
connectToMasterAs

Desciption

Connect to master node as a “client” or “slave”. Use this command to connect a local render node to the master.

Usage

Syntax: ... --connectToMasterAs <client or slave>

Example: Connect the local node to the master as a client.

sqn --connectToMasterAs client

Note

This command must be executed on the local node.

csv

Desciption

Display output in a comma separated values (CSV).

Usage

Syntax: ... --csv

Example: Display job queue contents in csv format.

sqn --jobQueueShow  --csv

Example: Display render farm nodes in csv format.

sqn --renderFarmShow  --csv
curCPUSpeed

Desciption

Returns the current CPU speed for the specified render nodes. If the “–node” option is not specified, the default is to return the CPU speed for the local node.

Usage

Syntax: ... --curCPUSpeed

Example: Get current CPU speed for all slave nodes.

sqn --curCPUSpeed --node slaves --delay 1
debug

Desciption

Used for internal testing.

Usage

Syntax: ... --debug <internal-option>

Example: Display available options.

sqn --debug help

Example: Queue up 1000 verification jobs for testing.

sqn --debug simulate --startFrame 1 --endFrame 1 --max 1000  --delay 1ms

Example: Queue up 1000 verification jobs for testing but don't show any output.

sqn --debug simulate --startFrame 1 --endFrame 1 --max 1000  --delay 1ms --quiet

Warning

This command is used for internal testing only.

delay

Desciption

Used to periodically repeat the execution of a command. Append “ms” for milli-second resolution.

Usage

Syntax: ... --delay <seconds>

Example: Display the output of the job queue every 5 seconds

sqn --jobQueueShow  --delay 5

Example: Display render farm status every 8 seconds.

sqn --renderFarmShow  --delay 8

Example: Execute a job and jobslice performance test every 100ms

sqn --debug  jobPerfTest --delay 100ms
enableSSA

Desciption

Enable alternate SSA account for render jobs (Windows ONLY).

Usage

Syntax: ... --enableSSA

Example: Submit a verification job but use specified SSA account credentials.

sqn --netVerTest --enableSSA --usernameSSA "SquidNet Admin" --passwordSSA ********
exceptionsClear

Desciption

Clear all render farm exceptions.

Usage

Syntax: ... --exceptionsClear

Example: Clear all exceptions

sqn --exceptionsClear
exceptionsShow

Desciption

Displays all render farm exceptions.

Usage

Syntax: ... --exceptionsShow

Example: Displays all exceptions.

sqn --exceptionsShow
execCmd

Desciption

Execute script on specified nodes..

Usage

Syntax: ... --execCmd <path-to-script>

Example: Run the specified script on all Windows nodes and show script output.

sqn --execCmd S:\logs\setup-node.bat --node windows --execCmdShow

Example: : Run the specified script on all Linux nodes.

sqn --execCmd S:\logs\setup-node.sh --node linux  --execCmdShow

Example: : Run the specified script on all Mac OS nodes.

sqn --execCmd S:\logs\setup-node.sh --node osx  --execCmdShow

Example: In a mixed render farm, execute a BASH script on Mac OS and Linux render nodes.

sqn --execCmd $XPATH(SCRIPTS)\test.sh --node linux
sqn --execCmd $XPATH(SCRIPTS)\test.sh --node osx

Example: : Run the specified script on nodes RENDERNODE12 and RENDERNODE13

sqn --execCmd S:\logs\setup-node.bat --node RENDERNODE12, RENDERNODE13

Note

The”$XPATH(SCRIPTS)” translation path points to a shared network folder.

execCmdShow

Desciption

Show the output from executed script..

Usage

Syntax: ... --execCmdShow

Example: Run the specified script on all Windows nodes and show script output.

sqn --execCmd S:\logs\setup-node.bat --node windows --execCmdShow
help

Desciption

Display SquidNet (sqn utility) commnd line options.

Usage

Syntax: ... --help

Example:

sqn --help
jobHistoryClear

Desciption

Clears job history on master node.

Usage

Syntax: ... --jobHistoryClear

Example: Clear the job history queue.

sqn --jobHistoryClear
jobHistoryShow

Desciption

Show job history.

Usage

Syntax: ... --jobHistoryShow

Example:

sqn --jobHistoryShow
jobInputQueueShow

Desciption

Shows the contents of the masters job input queue.

Usage

Syntax: ... --jobInputQueueShow

Example: Display input queue contents.

sqn --jobInputQueueShow
jobQueueClear

Desciption

Removes (cancels) all entries in job queue.

Usage

Syntax: ... --jobQueueClear

Example: Clear the job history queue.

sqn --jobHistoryClear

Example: Clear entire job queue.

sqn --jobQueueClear

Caution

Use this command with caution. Job queue entries are not recoverable.

jobQueueShow

Desciption

Shows job queue listing..

Usage

Syntax: ... --jobQueueShow <options>

Example: Clear the job history queue.

sqn --jobHistoryClear

Example: Display contents of job queue.

sqn -- jobQueueShow

Example: Display contents of job queue but don't show column header.

sqn --jobQueueShow --noHeader

Example: Show all available columns.

sqn --jobQueueShow --columnShow

Example: Output job queue contents on CSV format

sqn --jobQueueShow  --csv

Example: Display contents of job queue every 5 seconds.

sqn --jobQueueShow  --delay 5

Example: Display specific columns for job queue listing.

sqn --jobQueueShow --column "Job Id",Frames,Slices,Owner --noHeader
jobRemoveCompleted

Desciption

Remove any completed jobs from job queue.

Usage

Syntax: ... --jobRemoveCompleted

Example: .

sqn --jobRemoveCompleted
jobRequeue

Desciption

Restart completed job.

Usage

Syntax: ... --jobRequeue <job-id>

Note: When restarted, all job slices will b reprocessed.

Example: Restart job id "#1542-A" and reprocess all job slices.

sqn --jobRequeue #1542-A
jobRestartError

Desciption

Restart a job that’s in an error state.

Usage

Syntax: ... --jobRestartError <job-id>

Note: Only applies to jobs in an error state.

Example: Restart job id #1542-E

sqn -- jobRestartError #1542-E
jobSliceCacheShow

Desciption

Displays contents of job slice cache.

Usage

The job slice cache a s list of all recently accessed job slices. The list is maintained in memory on the master node and is periodically flushed to disk to conserve memory resources.

Syntax: ... --jobSliceCacheShow

Example: Display contents of job slice cache.

sqn --jobSliceCacheShow
jobSliceEnvLog

Desciption

Used with the “–submit” command to dump render node system environment variables to application’s log file.

Usage

Syntax: ... --jobSliceEnvLog

Example:

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:" --jobSliceEnvLog
jobSliceLogShow

Desciption

Display application log for selected job slices.

Usage

Syntax: ... --jobSliceLogShow <jobslice-index>

Example: Show applications logs for slices 1,2 and 3.

sqn --jobId #1542-A --jobSliceLogShow 1,2,3
jobSliceRequeue

Desciption

Requeue job’s selected job slices.

Usage

Syntax: ... --jobSliceRequeue <jobslice-index>

Example: Requeue job slices 1,2 and 3 for job id #1542-A

sqn --jobId #1542-A --jobSliceRequeue 1,2,3
jobSliceShow

Desciption

Displays job slice list for selected job id.

Usage

Syntax: ... --jobSliceShow

Example: Display job slices for job id #1542-A

sqn --jobId #1542-A --jobSliceShow
killServer

Desciption

Stop SquidNet server on specfied node(s) after a short delay.

Usage

Syntax: ... --killServer <delay-time-secs>

Example: Kill server on node HELENA after a 20 second delay.

sqn --killServer 20 --node HELENA
licenseInUse

Desciption

Displays all used licenses and the nodes that are using them..

Usage

Syntax: ... --licenseInUse

Example: Displays allocated licenses.

sqn --licenseInUse
licenseRegister

Desciption

Register license from a text file.

Usage

Syntax: ... --licenseRegister <license-file>

Example: Register license file.

sqn --licenseRegister license.txt

Example: When setting maser node, also register license.

sqn --masterSet thor --licenseRegister license.txt
localConfig

Desciption

Displays local configuration settings.

Usage

Syntax: ... --localConfig

Example:  Display local configuration settings.

sqn --localConfig

Output:

Local node name          : THOR (IPADDR: 192.168.3.1)
Master node name         : THOR
SquidNet version         : 3.00
Local node type          : MASTER
WINDOWS Version numbers  : 6.2
Installation path        : C:\Program Files (x86)\SquidNetSoftware\SquidNet
Configuration path       : \\WDMYCLOUDEX4\Public\SquidNet\SquidNetConfig
Application profile path : \\WDMYCLOUDEX4\Public\SquidNet\SquidNetConfig\ApplicationPathProfiles.dat
Translation path         : \\WDMYCLOUDEX4\Public\SquidNet\SquidNetConfig\PlatformPathTranslations.dat
Mapped Drive path        : \\WDMYCLOUDEX4\Public\SquidNet\SquidNetConfig\MappedDrives.dat
lock

Desciption

Lock specified nodes to prevent them from processing jobs. If nodes are in the process of rendering jobs, locking is done after the job completes.

Usage

Syntax: ... --lock

Example: Lock nodes RENDERNODE10 and RENDERNODE11

sqn --lock --node rendernode10,rendernode11

Example: Lock all client nodes

sqn --lock --node clients

Example: Lock slave nodes

sqn --lock --node slaves

Example: Lock all Windows nodes

sqn --lock --node windows

Example: : Lock all nodes

sqn --lock --node all

Example: : Lock all Linux nodes

sqn --lock --node linux
lockNow

Desciption

Locks specified nodes and cancel any currently processing jobs.

Usage

Syntax: ... --lockNow

Example: Immediately lock all nodes.

sqn -lockNow--node all
loginShow

Desciption

Displays logged in users on specified nodes.

Usage

Syntax: ... --loginShow

Example: Displayed all logged in users on Windows nodes.

sqn --loginShow --node windows
mappedPathShow

Desciption

Displays mapped drives on local node.

Usage

Syntax: ... --mappedPathShow

Example: Display mapped drives on local node.

sqn --mappedPathShow

Output:

Mapped Drives:

        Q:\ \\raid-server00\volume_1\MAIN-BACKUP
        S:\ \\WDMYCLOUDEX4\Public\SquidNet
        W:\ \\WDMYCLOUDEX4\Public
        Y:\ \\EPSON0FF9E8\USBSTORAGE
        Z:\ \\EPSON0FF9E8\MEMORYCARD
masterProcess

Desciption

Determine if master can render jobs.

Usage

Syntax: ... --masterProcess <true or false>

Valid Boolean values include: true, false, yes,no,1,0,enable,disable.

Example:

sqn --masterProcess true
masterSet

Desciption

Sets the specified node as the master and resets all other render farm nodes to SLAVES.

Usage

Syntax: ... --masterSet <nodename>

Before using this command, make sure to clear job queue first by using "--jobQueueClear" command.

Valid Boolean values include: true, false, yes,no,1,0,enable,disable.

Example: Set THOR as the master node and register license at the same time.

squidnet --masterSet THOR --licenseRegister license.txt
max

Desciption

Used to by some command to specify a maximum value.

Usage

Syntax: ... --max <integer-value>

Example:

sqn .... --max 12 ....
min

Desciption

Used to by some command to specify a minimum value.

Usage

Syntax: ... --min <integer-value>

Example:

sqn .... --min 12 ....
mkDir

Desciption

Create a directory tree.

Usage

Syntax: ... --mkDir <path-to-create>

Example: Create a directory tree under using" SQUIDDIR" translation variable.

sqn --mkDir $XPATH(SQUIDDIR)\dir1\dir2\dir3
netQueueShow

Desciption

Displays a list of nodes that are actively processing jobs.

Usage

Syntax: ... --netQueueShow

Example: Display a list of nodes that are working on jobs.

sqn --netQueueShow
netVerTest

Desciption

Submits a SquidNet Verification test job.

Usage

A SquidNet Verification job is just a job that tests out basic render farm functionality including:

• Verifying master slice distribution.
• Application launch and execution.
• Client and slave slice completion and response.

Syntax: ... --netVerTest

Example: Submits a SquidNet Verification test job.

sqn --netVerTest
node

Desciption

Use to pass node names to CLI commands.

Usage

Syntax: ... --node <option>


Here are the possible options:

• all           Apply command to all render farm nodes.
• master        Apply command to master node only.
• clients       Apply command to all client nodes.
• slaves        Apply command to all slave nodes.
• windows       Apply command to all Windows nodes.
• osx           Apply command to all Mac OS nodes.
• linux         Apply command to all Linux nodes.
• <pool-name>   Apply command to all nodes that belong to specified pools.
• <node-name>   Apply command to specified node names.


Example: Display information about all slave nodes

sqn --nodeInfo --node slaves
nodeInfo

Desciption

Displays node information.

Usage

Syntax: ... --nodeInfo

Note: If "--node" is not specified, defaults to local server node.

Example: Display information about local server.

sqn --nodeInfo

Example: Display information about all slave nodes

sqn --nodeInfo --node slaves

Example: Display information about nodes THOR and HELENA

sqn --nodeInfo --node thor,helena
nodeTypeSet

Desciption

Set the type of SquidNet node.

Usage

Syntax: ... --nodeTypeSet <node-type>

Options can be one of “master”, “client”, “slave” or “peer”..

Example: Set node RENDERNODE 12 to be a slave.

sqn –nodeTypeSet slave –node RENDERNODE12
noHeader

Desciption

Prevents the display of column headers.

Usage

Syntax: ... --noHeader

Example: Show contents of job queue but don't display column header.

sqn --jobQueueShow --noHeader
noWait

Desciption

Don’t wait for command to complete. Instead, return control back to console as soon as command is queued.

Usage

Syntax: ... --noWait

Example: Create MPEG4 videos with specified frame-rate, resolution and aspect-ratio.

sqn --video S:\Images\flames --videoOutputDir S:\Archives\Videos --videoFrameRate 29 --videoResolution 800x600 --aspectRatio 4:3 --codec mpeg4 --noWait
optionsFile

Desciption

Specify options in text file. This is an alternate method of specifying command line options..

Usage

Syntax: ... --optionsFile <path-to-options-file>

Example:  Specify request options in text file.

sqn --submit --template 3dsmax --optionsFile 3dsmax.txt

Contents of optionsLightWave.txt options file:

    --appPath $APP(3DSMAX-64BIT)
    --jobId maxJob#1
    --sceneName Shot_001
    --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max"
    --createOutputDir
    --outputDir $XPATH(SQUIDDIR)\Images\radiosity1
    --imagePrefix test_
    --imageFormat  "PNG Image File"
    --imageSize "VGA (640 x 480)"
    --priority 1
    --startFrame 1
    --endFrame 20
    --framePerSlice 1
    --useAllCores
    --pools A
    --poolsAlternate B
    --notifyOptions all
    --include
    --processingNodes rendernode12
    --onCondType requeue
    --onCondString "Error opening scene file:"

Here is the same command with all options specified on command line:

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1X --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"

---------------------------------------------------------------------------------------------------------------
Example:  Specify request options in text file.

sqn --submit --template LightWave --optionsFile optionsLightWave.txt

Contents of optionsLightWave.txt options file:

    --appPath   $APP(LW11)
    --jobId     Lightwave Scene 001
    --startFrame        1
    --endFrame  5
    --framePerSlice     1
    --priority  19
    --configFolder      \\raid-server00\Volume_1\SquidNet\LightWaveProjects\LW10\Config
    --contentFolder     \\raid-server00\Volume_1\SquidNet\LightWaveProjects\Except_GiChapel
    --sceneFile \\raid-server00\Volume_1\SquidNet\LightWaveProjects\Except_GiChapel\Scenes\Chapel_v002.lws
    --username  MyFirstName
    --comment   Test scene: Lightwave Scene 001
    --notes     Some notes for this job
    --errsBeforeStop    20
    --outputDir \\RAID-SERVER00\Volume_1\SquidNet\LightWaveProjects\Except_GiChapel\Images
    --imagePrefix       chapel_
    --imageSize SVGA (800 x 600)
    --imageFormat       LW_PICT32(.pct)
    --processingNodes RENDERNODE11,RENDERNODE12
    --compAction        remove

Here is the same command with all options specified on command line:

sqn --submit --template LightWave --appPath $APP(LW11) --jobId Lightwave Scene 001 --startFrame 1 --endFrame 5 --framePerSlice 1 --priority 19 --configFolder \\raid-server00\Volume_1\SquidNet\LightWaveProjects\LW10\FromRalph--contentFolder \\raid-server00\Volume_1\SquidNet\LightWaveProjects\Except_GiChapel --sceneFile \\raid-server00\Volume_1\SquidNet\LightWaveProjects\Except_GiChapel\Scenes\Chapel_v002.lws --username MyFirstName --comment Test scene: Lightwave Scene 001 --notes Some notes for this job --errsBeforeStop 20 --outputDir     \\RAID-SERVER00\Volume_1\SquidNet\LightWaveProjects\Except_GiChapel\Images --imagePrefix chapel_ --imageSize SVGA (800 x 600) --imageFormat LW_PICT32(.pct) --processingNodes RENDERNODE11,RENDERNODE12 --compAction remove
pack

Desciption

Pack the input folder into the specified output file.

Usage

Syntax: ... --pack <input-dir> and other options.

Example: Pack S:\Images\0030-XSI-Fire-Ring folder to create E:\temp\0030-XSI-Fire-Ring.pack archive file.

sqn --pack S:\Images\0030-XSI-Fire-Ring --outputFile E:\temp\0030-XSI-Fire-Ring.pack
passwordSSA

Desciption

Password for alternate SSA account. (Windows ONLY).

Usage

Syntax: ... --passwordSSA <password-to-use>

Example: Submit a verification job but use specified SSA account credentials.

sqn --netVerTest --enableSSA --usernameSSA "SquidNet Admin" --passwordSSA ********
pidChildShow

Desciption

Display all children of specified process id (PID).

Usage

Syntax: ... --pidChildShow <pid>

Example:

sqn --pidChildShow 5768
pingTest

Desciption

Connects to specified node and remove connection time.

Usage

Syntax: ... --pingTest

Note:  If "--node" is not specified, defaults to local server node.

Example: Do ping test on local server.

sqn --pingTest

Example: Do ping test on all slave nodes

sqn --pingTest --node slaves

Example: Do ping test on nodes THOR and HELENA

sqn --pingTest --node thor,helena
poolShow

Desciption

List nodes associated with specified pool.

Usage

Syntax: ... --poolShow <poolname or "all>

Example: Show which nodes belong to "EVENING-RENDER" pool.

sqn --poolShow EVENING-RENDER
quiet

Desciption

Used on specific command to disable command output.

Usage

Syntax: ... --quiet

Example: Send WOL packet to all nodes but don’t produce any output messages to console.

sqn –wol --node all  --quiet
reboot

Desciption

Reboot specified node(s).

Usage

Syntax: ... --reboot

Example:  Reboot node RENDERNODE12

sqn --reboot  --node RENDERNODE12

Example: Reboot all slave nodes

sqn --reboot  --node slaves


Example: Reboot all client nodes

sqn --reboot  --node clients
removeOffline

Desciption

Remove all offline nodes from list of known nodes.

Usage

Syntax: ... --removeOffline

Note: Don't execute this command if you rely on WOL to wakeup nodes.

Example:

sqn --removeOffline
renderFarmShow

Desciption

Displays status of render farm nodes.

Usage

Syntax: ... --renderFarmShow

Example: Display status of render farm nodes.

sqn --renderFarmShow

Example: Show selectable column names

sqn --renderFarmShow --columnShow

Example: Display status of render farm nodes but only show "node" and "type" columns.

sqn --renderFarmShow --column node,type

Example: Display status of render farm nodes but don't show column header.

sqn --renderFarmShow --noHeader

Example: Show output in CSV format.

sqn --renderFarmShow --csv
removeDependency

Desciption

Removes dependent job from specified job ID.

Usage

Syntax: ... --removeDependency <job-id>

Example: Remove job #1321's dependency on job id #1390

sqn --jobId #1321 -- removeDependency #1390
requestShow

Desciption

Remove all offline nodes from list of known nodes.

Usage

Syntax: ... --requestShow

Example: Submit 3dsmax command and display request parameters.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --requestShow
resetFarm

Desciption

Resets all render farm nodes to PEERs.

Usage

Syntax: ... --resetFarm

Example:

sqn --resetFarm

Warning

Using this command will convert all nodes (master, clients and slaves) to PEER node types. If executed, your render farm will have to be reconfigured again.

resetIdleTime

Desciption

Reset idle time on specified nodes.

Usage

Syntax: ... --resetIdleTime <node>

Note: If "--node" option is not specified, the local server's idle time is reset.

Example: Reset idle time on all nodes.

sqn --resetIdleTime --node all
resetLocal

Desciption

Resets local node to PEER status.

Usage

Use this command when master node is not available and you need to reconfigure the local node to a PEER

Syntax: ... --resetLocal

Example: Reset local node to type "PEER"

sqn --resetLocal
restart

Desciption

Restarts local SquidNet server.

Usage

Syntax: ... --restart

Example: Restart local SquidNet server

sqn --restart
resume

Desciption

Resume a suspended job.

Usage

Syntax: ... --resume

Example: Resume job maxJob#1 to a processing state

sqn --jobId maxJob#1 --resume
shutdown

Desciption

Shutdown specified node(s).

Usage

Syntax: ... --shutdown

Example:  Shutdown node RENDERNODE12

sqn -- shutdown --node RENDERNODE12

Example: Shutdown all slave nodes

sqn -- shutdown --node slaves


Example: Shutdown all client nodes

sqn -- shutdown --node clients
size

Desciption

Used by various commands to pass in an integer value..

Usage

Syntax: ... --size <input>

Example: Do a performance test to master using 10 threads and use 100,000 byte messages.

sqn --speedTest --node master --numThreads 10 --size 100000
speedTest

Desciption

Does a network performance test on specified node(s) by establishing a connection and sending messages back and forth for a short period of time.

Usage

Syntax: ... --speedTest

Example: Do a performance test to master using 10 threads and use 100000 byte messages.

sqn --speedTest --node master --numThreads 10 --size 100000

Example: Do the same test as above but run against client nodes instead.

sqn --speedTest --node clients --numThreads 10 --size 100000
start

Desciption

Starts local SquidNet server.

Usage

Syntax: ... --start

Example: Start local SquidNet server.

sqn --start
status

Desciption

Displays a quick summary of the master’s status.

Usage

Syntax: ... --status

Example:

sqn --status

Output:

    Master node              : THOR
    Farm status              : OFFLINE
    Active connections       : 4
    Input queue              : 0
    Processing queue         : 3
    Total queued             : 3
    Jobs submitted/completed : 24/22
    Slices processed         : 698
    Nodes                    : 14
    Clients                  : 1 (1 offline)
    Slaves                   : 12 (12 offline)
stop

Desciption

Stops local SquidNet server.

Usage

Syntax: ... --stop

Example: Stop local SquidNet server

sqn --stop
suspend

Desciption

Suspend specified job and wait for any active job slices to complete.

Usage

Syntax: ... --suspend

Example: Suspend job

sqn --jobId maxJob#1 --suspend
suspendNow

Desciption

Suspend specified and immediately cancel any active job slices.

Usage

Syntax: ... --suspendNow

Example: Suspend job immediately

sqn --jobId maxJob#1 --suspendNow
template

Desciption

Used to display available job templates or to specify when template to use in a job request.

Usage

Syntax: ... --template <template-name or "all">

Example: Show all available job templates.

sqn --template all

Example: Submit job request for Terragen template.

sqn --submit --sceneName "TG Test" --template terragen --tileRequest --tileRenderer "terragen" --tileRows 10 --tileCols 10  --tileMode grid --tileRegions all --tileImagePrefix water-space --tileImageFmtIdx 1 --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 1 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\terragen2 --outFilename water-space$(REG_MASK) --imageWidth 1280 --imageHeight 720 --outNumFormat 06 --outFormat tif --useAllCores --include --processingNodes alvserver-ofc,rendernode12,rendernode11,rendernode08
templateFormatShow

Desciption

Displays internal fields for specified template.

Usage

Syntax: ... --template <template-name or "all">

Example: Display internal fields for specified template.

sqn --templateFormatShow 3dsmax
throughPutShow

Desciption

Displays current network input/output statistics for all render farm nodes.

Usage

Syntax: ... --throughPutShow

Example: Display current throughput rates.

sqn --throughPutShow
translationPathShow

Desciption

Displays all translation profiles.

Usage

Syntax: ... --translationPathShow

Example: Display all translation profiles.

sqn --translationPathShow
unlock

Desciption

Unlock specified nodes.

Usage

Syntax: ... --unlock

Example: Unlock nodes RENDERNODE10 and RENDERNODE11

sqn -- unlock --node rendernode10,rendernode11

Example: Unlock all client nodes

sqn -- unlock --node clients

Example: Unlock slave nodes

sqn -- unlock --node slaves

Example: Unlock all Windows nodes

sqn -- unlock --node windows

Example: : Unlock all nodes

sqn -- unlock --node all

Example: : Unlock all Linux nodes

sqn --unlock --node linux
unpack

Desciption

Extract files created with “–pack” option.

Usage

Syntax: ... --unpack <input-file>

Example: Extract files from 0030-XSI-Fire-Ring.pack to E:\temp\ folder.

sqn --unpack E:\temp\0030-XSI-Fire-Ring.pack --outputDir E:\temp\
updateFarm

Desciption

Update the SquidNet software version on the render farm with the installers in the specified folder.

Usage

This command will automatically update the entire render farm with the installers present in the specified folder. Make sure that the folder only contains installers for the same SquidNet version.

Syntax: ... --updateFarm <path -to- installer-folder>

Example: Update the render farm to SquidNet version 2.266P93.

Note: Make sure the installer files in the folder are all for the same SquidNet software version.

sqn --updateFarm C:\Squidnet-Releases\squidnet-2.66P93
updateNode

Desciption

Update specified nodes with a SquidNet installer.

Usage

Syntax: ... --updateNode <path -to- installer-file>

Example: Update all Windows nodes to specified SquidNet version

sqn --updateNode C:\Squidnet-Releases\squidnet-windows-2.66P100.tar.gz --node all

Example: Update all Linux nodes to specified SquidNet version

sqn --updateNode C:\Squidnet-Releases\squidnet-linux-2.66P100.tar.gz --node all

Example: Update all Mac OS nodes to specified SquidNet version

sqn --updateNode C:\Squidnet-Releases\squidnet-osx-2.66P100.tar.gz --node all
usernameSSA

Desciption

User name for alternate SSA account. (Windows ONLY).

Usage

Syntax: ... --usernameSSA <account-name>

Example: Submit a verification job but use specified SSA account credentials.

sqn --netVerTest --enableSSA --usernameSSA "SquidNet Admin" --passwordSSA ********
version

Desciption

Display SquidNet software version of local server.

Usage

Syntax: ... --version

Example:

sqn --version
video

Desciption

Display SquidNet software version of local server.

Usage

Scans the specified input folder and creates an output animation video for each image sequence found.

For example, if there are 3 image sequences in input folder named fire[0001-0400].jpg, yard[0001-0400].png and sky[0001-0400].png, the rendered animation videos will be fire_jpg.mp4, yard_png.mp4 and sky_png.mp4, respectively.

If not specified, these are the default options:

    --videoFrameRate    25
    --videoResolution   1280x720
    --aspectRatio       16x9
    --codec             h264
    --node              <localhost>

If the "--node <nodename>" option is not specified, the command is executed on the local SquidServer.

Syntax: ... --video <input-folder>

Note: “--videoOutputDir” option must be specified.

Example: Create H.264 videos for every image sequence found in S:\Images\flames folder and place in S:\Archives\Videos folder. The "--noWait" option queues the request and returns control back to the shell.

sqn --video S:\Images\flames --videoOutputDir S:\Archives\Videos --noWait

Example: Create same videos with a different frame-rate, resolution, aspect-ratio and instead of H.264, create an MPEG4 formatted AVI file.

sqn --video S:\Images\flames --videoOutputDir S:\Archives\Videos --videoFrameRate  29 --videoResolution  800x600 --aspectRatio 4:3 --codec mpeg4 --noWait

Example: Same command as above, but this time, render video on node RENDERNODE14

sqn --video S:\Images\flames --videoOutputDir S:\Archives\Videos --videoFrameRate  29 --videoResolution  800x600 --aspectRatio 4:3 --codec mpeg4 --noWait --node RENDERNODE14
virtualCoreSet

Desciption

Assign virtual cores to specified node.

Usage

Temporarily override the actual number of physical cores available on specified node(s).

Syntax: ... --virtualCoreSet <Number of virtual cores to assign to node(s)>

Note: “--node” option must also be specified.

Example: Assign 32 virtual cores to all slave nodes.

sqn --virtualCoreSet 32 --node slaves

Example: Assign 16 virtual cores to master node

Sqn --virtualCoreSet 16 --node master

Example: Assign 16 virtual cores to render node RENDERNODE12

sqn --virtualCoreSet 16 --node RENDERNODE12

Caution

This command is used for performance testing only and should not be used under normal operating conditions. It’s possible that incorrectly using this command may force you to reboot your entire render farm. The real number of node cores can be reset using “–virtualCoreSet 0” or restarting the SquidNet servers that were modified.

wait

Desciption

Return to host shell when specified command completes.

Usage

Syntax: ... --wait

Example: Execute this 3DSMAX tile render request and wait for command to complete.

sqn --submit --sceneName "3DSMAX" --jobId max-cli-tile-render-framelist --template 3dsmax --tileRequest --tileRenderer "3dsmax" --tileRows 10 --tileCols 1  --tileMode grid --tileRegions all --tileImagePrefix max-cli-tile-render-framelist_ --tileImageFmtIdx 1 --appPath $APP(3DSMAX-64BIT) --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max"  --frameList 1,2,4,6,9,15-18 --priority 4 --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\3dsmax\max-cli-tile-render-framelist --imagePrefix max-cli-tile-render-framelist_ --imageWidth 1280 --imageHeight 720 --imageFormat "PNG Image File" --useAllCores --include --processingNodes rendernode12,rendernode11,rendernode08 --wait
winLogonAccountSet

Desciption

For Windows render nodes, determines whether the SquidNet services runs under the Local System account or SSA account.

Usage

Typically, domain accounts need to run under the Local System account.  Check with your IT professional to determine your recommended setting.

Syntax: ... --winLogonAccountSet <localsystem or SSA>

Example: Make the SquidNet service running on RENDERNODE12 use the Local System account

sqn --winLogonAccountSet localsystem --node rendernode12

Example: Make all SquidNet services use the Local System account.

sqn --winLogonAccountSet localsystem --node windows

Example: Make the SquidNet service running on nodes RENDERNODE12 and RENDERNODE13 use the SSA account

sqn --winLogonAccountSet ssa --node rendernode12, rendernode13
wol

Desciption

Send wake-on-lan (WOL) packets to offline nodes.

Usage

Syntax: ... --wol

Example: Wake up all nodes that are sleeping (offline).

sqn --wol

or
sqn --wol --node all

Example: Same command but don't display anything.

sqn --wol --quiet

Example: Wake up all slave nodes

sqn --wol --node slaves

Example: Wake up all client nodes

sqn --wol --node clients

Example: Wake up nodes RENDERNODE01 and RENDERNODE02

sqn --wol --node RENDERNODE01,RENDERNODE02
workHistoryClear

Desciption

Clears work queue on specified node.

Usage

Syntax: ... --workHistoryClear <nodename>

Example: Clear the job slice history queue on node "thor".

sqn --workHistoryClear thor
workHistoryShow

Desciption

Return the work queue history for the specified node.

Usage

Syntax: ... --workHistoryShow <nodename>

Example: Show the job slices processed on node "thor".

sqn --workHistoryShow thor

7.2 Job Command Line Options

Job Command Line Options
Command Line Option Description
appLogMax

Desciption

Specifies the maximum size of the job slice application log file. Defaults to 1000 (1MB) if not specified.

Usage

Syntax: ... --appLogMax <application-log-size-in-kilobytes>

Example: Limit 3DSMAX application log file size for each job slice log to 4MB.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000
appPath

Desciption

Specifies the application profile to use in a job submission. Use the Application Path Manager in the SquidNet GUI to create application profiles.

Usage

Syntax: ... --appPath <application-profile>

Example:  Submit a 3DSMAX job and use the MODO_601-SP3 application profile.

sqn --submit --sceneName "MODO Test" --template modo --tileRequest --tileRenderer "modo" --tileRows 10 --tileCols 10  --tileMode grid --tileRegions all --tileImagePrefix test_ --tileImageFmtIdx 1 --appPath $APP(MODO_601-SP3) --sceneFile "$XPATH(SQUIDDIR)\ModoProjects\Content\C9_Animation.lxo" --startFrame 1 --endFrame 1 --priority 4 --outputDir $XPATH(SQUIDDIR)\Images\#0012-City-Car-Animation-MACRO_TR --imagePrefix test_$(REG_MASK) --imageWidth 1920 --imageHeight 1080 --imageFormat png --useAllCores --include --processingNodes alvserver-ofc,rendernode12,rendernode11,rendernode08
checkOutputContent

Desciption

Check output folder for generated images. If no images are found, job is placed in an error state.

Usage

Syntax: ... --checkOutputContent

Example: Submit 3DSMAX job and verify that output images are created.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent
clearOutputDir

Desciption

If specified with job request, remove any files in output folder.

Usage

Syntax: ... --clearOutputDir

Example: Submit 3DSMAX job and remove any files (and sub-directories) in output folder.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir
colorId

Desciption

Used to assign a color to a job request. When specified, the job is displayed in the GUI as indicated.

Usage

Syntax: ... --colorId <color-list>

The format is specifed as: red (0-255),green (0-255),blue (0-255),alpha (0-255). Example: --color 255,0,0,128 will product a solid red color with 50% transparency.

Example: Submit 3DSMAX job and assign a bright green color to it.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --colorId 0,255,0,255
comment

Desciption

Assigns a comment to a job request.

Usage

Syntax: ... --comment <text-string>

Example: Assign a comment to 3DSMAX job request.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --colorId 0,255,0,255 --comment "This is a test"
compAction

Desciption

Action to perform when job completes processing.

Usage

Syntax: ... --compAction <action>

By default, jobs are immediately  removed from job queue when they complete.

Available options are:

    leave   Do not remove job from queue when it complete. User will have to remove manually.
    remove  (Default mode) Remove job from queue upon completion
    after   Remove from queue after the specified number of hours. Use "--compActionHrs" to specify hours value.

Example: Leave job in queue when it completes.

sqn --submit --sceneName "3DSMAX Test" --template 3dsmax --tileRequest --tileRenderer "3dsmax" --tileRows 10 --tileCols 1  --tileMode grid --tileRegions all --tileImagePrefix test_ --tileImageFmtIdx 1 --appPath $APP(3DSMAX-64BIT) --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max"  --frameList 1,2,4,6,9,15-18 --priority 4 --outputDir $XPATH(SQUIDDIR)\Images\radiosity --imagePrefix test_ --imageWidth 1280 --imageHeight 720 --imageFormat "PNG Image File" --useAllCores --include --processingNodes alvserver-ofc,rendernode12,rendernode11,rendernode08 --compAction leave
compActionHrs

Desciption

Indicates how long to leave job in queue after it completes.

Usage

Syntax: ... --compActionHrs <number-of-hrs>

Example: Wait 6 hrs after job completes to remove request from job queue.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --colorId 0,255,0,255 --comment "This is a test" --compAction after  --compActionHrs 6
copyFolder

Desciption

Copy output images to specified folder when job completes processing.

Usage

Syntax: ... --copyFolder <path-to-folder>

Example: When job completes, copy all files (including sub directories) to S:\Images\save folder.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 2 --framePerSlice 2 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --copyFolder S:\Images\save
createOutputDir

Desciption

Creates output folder in job request.

Usage

Syntax: ... --createOutputDir

Example: Create specified output folder when job is submitted.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 2 --framePerSlice 2 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --copyFolder S:\Images\save
dependentJobList

Desciption

Make job dependent on other jobs.

Usage

The “other” jobs must complete successfully before job can commence processing. Use this option to “chain” jobs together. A job can depend on more than one job and the chain can be of any length.

Syntax: ... --dependentJobList <comma seperated list of job ids>

Example: Make maxJob3 be dependent on jobs maxJob#1 and maxJob#2.  Job maxJob#3 will start processing after jobs maxJob#1 and maxJob#2 complete successfully.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#2 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#3 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity2 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 2 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:" --dependentJobList maxJob#1, maxJob#2
endFrame

Desciption

Specifies the end frame of an animation render.

Usage

Syntax: ... --endFrame <frame-number>

Example: Render frames 1 thru 20

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 2 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --moveFolder S:\Images\save
errsBeforeStop

Desciption

Specifies the number of job slice errors before job is place in error state.

Usage

Syntax: ... --errsBeforeStop <number-of-errors>

Example: Place job into error state after it 8 job slice errors are reached.

sqn  --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 2 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --moveFolder S:\Images\save  --errsBeforeStop 8
estimateCompletion

Desciption

If specified, renders at least on job slice (regardless of queue position) to calculate and estimate on how long before job is completed.

Usage

Syntax: ... --estimateCompletion

Example: Estimate completion time for a 3dsmax job.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 2 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --moveFolder S:\Images\save  --errsBeforeStop 8  --estimateCompletion
exclude

Desciption

Used with “–processingNodes” to only exclude nodes listed.

Usage

Syntax: ... --exclude

Example: Exclude nodes rendernode10, rendernode11 and rendernode12 from rendering pipeline.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 2 --useAllCores --pools A --poolsAlternate B --notifyOptions all --exclude --processingNodes rendernode10,rendernode11,rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --moveFolder S:\Images\save  --errsBeforeStop 8  --estimateCompletion
expectedExitCode

Desciption

Specifies successful completion status for job slices. Defaults to “0”.

Usage

Syntax: ... --expectedExitCode <numeric-value>

Example: Submit job and expect each job slice to complete with exit code 12.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT-2013) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 2 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode10,rendernode11,rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --moveFolder S:\Images\save  --errsBeforeStop 8  --estimateCompletion --expectedExitCode 12
frameList

Desciption

Specifies a list for frames to render.

Usage

Syntax: ... --frameList <frame-list>

Field usage:

    • "-" is the range selector. All frames in the range will be rendered in a single job slice.
    • ":" is also a range selector but each frame is rendered in a separate job slice.
    • "n" is an individual frame number. Each will be rendered in a separate job slice.

Usage examples:

    1,2,4,6,9,15-18     Render frames 1,2,4,6,9 and frames 15 thru 19, inclusive.
    2:5                 Render frames 2 thru 5, inclusive. Each frame will be rendered in a separate jobslice.
    2:5,7:10,11,14-17   Render frames 2 thru 5, 7 thru 10, 10, 11 and frames 14 thru 17, inclusive

Note: If used, "--startFrame", "--endFrame" and "--stepFrame" options are ignored.

Example: Tile render frames 1,2,4,6,9 and 15 thru18.

sqn --submit --sceneName "3DSMAX Test" --template 3dsmax --tileRequest --tileRenderer "3dsmax" --tileRows 10 --tileCols 1  --tileMode grid --tileRegions all --tileImagePrefix test_ --tileImageFmtIdx 1 --appPath $APP(3DSMAX-64BIT-2013) --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max"  --frameList 1,2,4,6,9,15-18 --priority 4 --outputDir $XPATH(SQUIDDIR)\Images\radiosity --imagePrefix test_ --imageWidth 1280 --imageHeight 720 --imageFormat "PNG Image File" --useAllCores --pools A --compAction leave --createOutputDir
framePerSlice

Desciption

Specifies the number of frames to assign to each job slice. If not specified, defaults to “1”.

Usage

Syntax: ... --framePerSlice numeric-value>

Example: Render frames 1 thru 20 but assign 2 frames per slice.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT-2013) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 2 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode10,rendernode11,rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --moveFolder S:\Images\save  --errsBeforeStop 8  --estimateCompletion
imageDisplayInterval

Desciption

Specifies how often preview images are displayed on local SquidNet user interface.

Usage

Syntax: ... --imageDisplayInterval <image-interval>

Example: Display every 5th image within the local SquidNet GUI.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT-2013) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 2 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode10,rendernode11,rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --moveFolder S:\Images\save  --errsBeforeStop 8  --estimateCompletion --imageDisplayInterval 5
imageFormat

Desciption

Specifies the output format (png, exr, tif, etc…) for rendered images.

Usage

Syntax: ... --imageFormat <image-format>

Note: The image format is template dependant. Use the "--template <template-name> to list possible values.

Example: Create PNG images for job.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT-2013) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 2 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode10,rendernode11,rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --moveFolder S:\Images\save  --errsBeforeStop 8  --estimateCompletion --imageDisplayInterval 5
imageHeight

Desciption

Specifies output image height.

Usage

Syntax: ... --imageHeight <numeric-value>

Example: Create output images with resolution of 1280x720

sqn --submit --sceneName "TG Test" --template terragen --tileRequest --tileRenderer "terragen" --tileRows 10 --tileCols 10  --tileMode grid --tileRegions all --tileImagePrefix water-space --tileImageFmtIdx 1 --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 1 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\terragen2 --outFilename water-space$(REG_MASK) --imageWidth 1280 --imageHeight 720 --outNumFormat 06 --outFormat tif --useAllCores --include --processingNodes rendernode11,rendernode12
imagePrefix

Desciption

Specifies image prefix of output images.

Usage

Syntax: ... --imagePrefix <image-prefix>

Example: Create images with " sample-image-[0000-0010].exr filenames.

sqn --submit --sceneName "B3D Test" --template blender --appPath $APP(BLENDER-64BIT) --sceneFile "$XPATH(BLENDER-262)\with spaces\dolphin-path.blend" --startFrame 1 --endFrame 10 --priority 4 --outputDir "S:\BlenderImages\test space" --imagePrefix sample-image- --imageFormat EXR --include --processingNodes thor
imageSize

Desciption

Specifies the output image resolution for rendered images.

Usage

Syntax: ... --imageSize <image-size>

Note: The image resolution format  is template dependant. Use the "--template <template-name> to list possible values.

Example: Create PNG images for job.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT-2013) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 2 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode10,rendernode11,rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --moveFolder S:\Images\save  --errsBeforeStop 8  --estimateCompletion --imageDisplayInterval 5
imageWidth

Desciption

Specifies output image width.

Usage

Syntax: ... --imageWidth <numeric-value>

Example: Create output images with resolution of 1280x720

sqn --submit --sceneName "TG Test" --template terragen --tileRequest --tileRenderer "terragen" --tileRows 10 --tileCols 10  --tileMode grid --tileRegions all --tileImagePrefix water-space --tileImageFmtIdx 1 --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 1 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\terragen2 --outFilename water-space$(REG_MASK) --imageWidth 1280 --imageHeight 720 --outNumFormat 06 --outFormat tif --useAllCores --include --processingNodes rendernode11,rendernode12
include

Desciption

Used with “–processingNodes” to only include nodes listed.

Usage

Syntax: ... --include

Example: Only render this job on nodes rendernode10, rendernode11 and rendernode12

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 2 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode10,rendernode11,rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --moveFolder S:\Images\save  --errsBeforeStop 8  --estimateCompletion
inputDir

Desciption

Specifies input path.

Usage

Syntax: ... --inputDir <path>

Example: Create video from image sequence in " S:\Images\#0012-City-Car-Animation MACRO" folder.

sqn --submit --template ffmpeg --appPath ffmpeg --inputDir "S:\Images\#0012-City-Car-Animation MACRO" --outputDir S:\Images\videos --videoFrameRate "60 fps" --videoResolution "hd720(1280x720)" --include --processingNode thor --useAllCores
jobDesc

Desciption

Specifies job description.

Usage

Syntax: ... --jobDesc <description>

Example: Create video from image sequence.

sqn --submit --template ffmpeg --appPath ffmpeg --jobDesc "Create video from image sequence" --inputDir "S:\Images\#0012-City-Car-Animation MACRO" --outputDir S:\Images\videos --videoFrameRate "60 fps" --videoResolution "hd720(1280x720)" --include --processingNode thor --useAllCores
jobId

Desciption

Specified name of job in render farm queue. If not specified, job identifier defaults to a unique id (generated by master node).

Usage

Syntax: ... --jobId <job-identifier>

Example: Submit request with job id "maxJob#1" to render farm queue.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 2 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode10,rendernode11,rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --moveFolder S:\Images\save  --errsBeforeStop 8  --estimateCompletion
jobScriptPrePath

Desciption

Execeute script before job starts processing.

Usage

When SquidNet executes job slice scipts, it'll automatically append the start-frame, end-frame and output-folder fields to the script command:

For example:  User script test.bat will be execited as test.bat 1 100 S:\image\output-folder

Syntax: ... --jobScriptPrePath <network-path>

Example: Run test.bat script before/after job starts/ends processing and before/after jobslice starts/ends processing.

sqn --netVerTest --startFrame 1 --endFrame 1 --jobScriptPrePath S:\Scripts\test.bat --jobScriptPostPath S:\Scripts\test.bat --sliceScriptPrePath S:\Scripts\test.bat --sliceScriptPostPath S:\Scripts\test.bat

Same command using translation path:

sqn --netVerTest --startFrame 1 --endFrame 1 --jobScriptPrePath $XPATH(SCRIPTS)\test.bat --jobScriptPostPath $XPATH(SCRIPTS)\test.bat --sliceScriptPrePath $XPATH(SCRIPTS)\test.bat --sliceScriptPostPath $XPATH(SCRIPTS)\test.bat
jobScriptPostPath

Desciption

Execeute script when job successfully completes processing.

Usage

When SquidNet executes job slice scipts, it'll automatically append the start-frame, end-frame and output-folder fields to the script command:

For example: User script test.bat will be execited as test.bat 1 100 S:\image\output-folder

Syntax: ... --jobScriptPostPath <network-path>

Example: Run test.bat script before/after job starts/ends processing and before/after jobslice starts/ends processing.

sqn --netVerTest --startFrame 1 --endFrame 1 --jobScriptPrePath S:\Scripts\test.bat --jobScriptPostPath S:\Scripts\test.bat --sliceScriptPrePath S:\Scripts\test.bat --sliceScriptPostPath S:\Scripts\test.bat

Same command using translation path:

sqn --netVerTest --startFrame 1 --endFrame 1 --jobScriptPrePath $XPATH(SCRIPTS)\test.bat --jobScriptPostPath $XPATH(SCRIPTS)\test.bat --sliceScriptPrePath $XPATH(SCRIPTS)\test.bat --sliceScriptPostPath $XPATH(SCRIPTS)\test.bat
jobSliceTimeoutError

Desciption

If specified, job will get into an error state if any job slice times out.

Usage

Syntax: ... --jobSliceTimeoutError

Example: Abort job if any slice times out.

sqn --submit --sceneName "TG Test" --template terragen --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 20 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\Images\terragen2 --outFilename water-space --outNumFormat 06 --outFormat bmp --useAllCores --sliceTimeoutMins 2 --jobSliceTimeoutError --errsBeforeStop 1 --include --processingNodes rendernode12
maxJobslices

Desciption

Limits the number of slices that can be active at any one time.

Usage

Syntax: ... --maxJobslices <numeric-value>

Example: Limit the number of concurrent job slices to 20.

sqn --submit --sceneName "TG Test" --template terragen --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 20 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\Images\terragen2 --outFilename water-space --outNumFormat 06 --outFormat bmp --useAllCores --sliceTimeoutMins 200 --jobSliceTimeoutError --errsBeforeStop 1 --maxJobslices 20 --include --processingNodes rendernode12
minMemAbort

Desciption

Used with “–minMemPct” option to indicate how many times a slice is allowed to be requeued before the job is placed in an error state. Defaults to “5” if not specified.

Usage

Syntax: ... --minMemAbort <numeric-value>

Example:

sqn --submit --sceneName "TG Test" --template terragen --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 20 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\Images\terragen2 --outFilename water-space --outNumFormat 06 --outFormat bmp --useAllCores --sliceTimeoutMins 200 --jobSliceTimeoutError --errsBeforeStop 1 --maxJobslices 20 --include --processingNodes rendernode12 --minMemAbort 8
minMemDisable

Desciption

Use this value to disable any memory limit checking. If not specified, “–minMemPct” defaults to 97%.

Usage

Syntax: ... --minMemDisable

Example: Disable all memory limit checking

sqn --submit --sceneName "TG Test" --template terragen --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 20 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\Images\terragen2 --outFilename water-space --outNumFormat 06 --outFormat bmp --useAllCores --sliceTimeoutMins 200 --jobSliceTimeoutError --errsBeforeStop 1 --maxJobslices 20 --include --processingNodes rendernode12 --minMemDisable
minMemGigaBytes

Desciption

Specify the minimum amount of memory (in GigaBytes) needed by each node to render job slices.

Usage

Syntax: ... --minMemGigaBytes <value-in-gigabytes>

Example: Auto-requeue any job slices when 80% of memory is utilized on any render node.

sqn --submit --sceneName "TG Test" --template terragen --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 20 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\Images\terragen2 --outFilename water-space --outNumFormat 06 --outFormat bmp --useAllCores --sliceTimeoutMins 200 --jobSliceTimeoutError --errsBeforeStop 1 --maxJobslices 20 --include --processingNodes rendernode12 --minMemAbort 5 --minMemPct 80 -- minMemGigaBytes 16
minMemPct

Desciption

Set the maximum amount of memory (percentage-wise) that can be used before the job slice is automatically requeued. If not specified, defaults to 97%.

Usage

Syntax: ... --minMemPct <numeric-value>

Example: Auto-requeue any job slices when 80% of memory is utilized on any render node.

sqn --submit --sceneName "TG Test" --template terragen --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 20 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\Images\terragen2 --outFilename water-space --outNumFormat 06 --outFormat bmp --useAllCores --sliceTimeoutMins 200 --jobSliceTimeoutError --errsBeforeStop 1 --maxJobslices 20 --include --processingNodes rendernode12 --minMemAbort 5 --minMemPct 80
minMemRemember

Desciption

If specified, do not re-render any slices to any render nodes that caused the slices to requeue because the maximum memory limit was reached. Use with “–minMemPct” option.

Usage

::

For example, The master not send any more slices to RENDERNODE12 if render node RENDERNODE12 told the master to requeue a job slice because it reached the maximum allowed memory limit specified with “–minMemPct” option.

Syntax: … –minMemminMemRemember

Example:

sqn –submit –sceneName “TG Test” –template terragen –appPath $APP(TERRAGEN) –sceneFile “S:Terragen2Open Water Animation Tests 3.tgd” –startFrame 1 –endFrame 20 –priority 4 –outputDir \raid-server00volume_1SquidNetImagesImagesterragen2 –outFilename water-space –outNumFormat 06 –outFormat bmp –useAllCores –sliceTimeoutMins 200 –jobSliceTimeoutError –errsBeforeStop 1 –maxJobslices 20 –include –processingNodes rendernode12 –minMemAbort 5 –minMemPct 80 –minMemRemember

moveFolder

Desciption

Move output images to specified folder when job completes processing.

Usage

Syntax: ... --moveFolder <path-to-folder>

Example: When job completes, move all files (including sub directories) to S:\Images\save folder.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 2 --framePerSlice 2 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --moveFolder S:\Images\save
notes

Desciption

Assigns text to specified job request.

Usage

Syntax: ... --notes <text>

Example: Assign a note to job request.

sqn --submit --sceneName "TG Test" --template terragen --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 20 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\Images\terragen2 --outFilename water-space --outNumFormat 06 --outFormat bmp --useAllCores --sliceTimeoutMins 200 --jobSliceTimeoutError --errsBeforeStop 1 --maxJobslices 20 --include --processingNodes rendernode12 --minMemAbort 5 --minMemPct 80 --minMemRemember --notes "This is a note
notifyOptions

Desciption

Sends GUI notification message for specific events.

Usage

Syntax: ... --notifyOptions <options-list>

    jobStart            Send notification when job starts
    jobComplete         Send notification when job completes
    jobSliceTimeout     Send notification when slice times out
    jobSliceRequeue     Send notification when slice is requeued
    jobSliceAbort       Send notification when slice is aborted
    jobSliceHold        Send notification when slice held
    jobSliceRelease     Send notification when slice released
    jobNoOutput         Send notification when job has not output content
    missingFrameRequeue Send notification when missing frames are detected
    licenseLimit        Send notification when license limits have been reached
    jobCancelled        Send notification when job is cancelled
    onCondition         Send notification when On Condition profiles have been executed
    jobSuspended        Send notification when job is suspended
    jobResumed          Send notification when job is resumed
    jobPriority         Send notification when job's priority is changed.
    jobSliceLowMemory   Send notification when slice is requeued because of low memory conditions
    jobSliceError       Send notification when slice errors out
    smallFrameRequeue   Send notification when an image is found that is smaller in size than others in same output folder
    other               Send all miscellaneous notifications
    all                 Enable all notifications

Example:

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file
numThreads

Desciption

Specifies the number of cores to use per job slice. Use “–useAllCores” option to use all cores on each render node.

Usage

Syntax: ... --numThreads <numeric-value>

Example: Submit Maya tile render request and specify that each job slice only use 2 cores.

sqn --submit --sceneName "MAYA-MR Test" --template maya --tileRequest  --tileRenderer "MentalRay" --useRenderer MentalRay --tileRows 10 --tileCols 10  --tileMode grid --tileRegions all --tileImagePrefix test_ --tileImageFmtIdx 1 --appPath $APP(MAYA-2014) --sceneFile "$XPATH(SQUIDDIR)\MayaProjects\SquidNet-Performance\scenes\SquidNet-Maya-Benchmark.mb"  --projectFolder $XPATH(SQUIDDIR)\MayaProjects\SquidNet-Performance --workDir $XPATH(SQUIDDIR)\MayaProjects\SquidNet-Performance\scenes --startFrame 1 --endFrame 1 --imageFilenameFormat name#.ext --priority 4 --outputDir $XPATH(SQUIDDIR)\Images\PT-0001-temp --imagePrefix test_$(REG_MASK) --pixelBound "$(REG_LEFT) $(REG_RIGHT) $(REG_BOTTOM) $(REG_TOP)" --imageWidth 1920 --imageHeight 1080 --imageFormat png --numThreads 2
onCondDelay

Desciption

Used with “–onCondType requeueDelay” option to indicate how long to wait before a job slice is requeued.

Usage

Syntax: ... --onCondDelay <numeric-value-in-mins >

Example: Submit 3DSMAX job and requeue any slice that has an application log that contains the "Error opening scene file:" string in it.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeueDelay --onCondString "Error opening scene file:"   --onCondDelay 5
onCondIgnore

Desciption

Specifies a list of comma separated exit codes that are to ignored. If a job slice returns one of the specified codes, the slice is marked as completed.

Usage

Syntax: ... --onCondIgnore <comma-separated-list-of-exitcodes>

Example: Submit 3DSMAX job and ingore any job slice return codes that are 211 and 213.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12    --onCondIgnore 211,213
onCondProfiles

Desciption

Specifies which OnCondition profiles to apply towards job.

Usage

Syntax: ... --onCondProfiles <onCondition-profiles>

Example: Submit 3DSMAX job and apply OnCondition profile "ERROR 32".

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12  --onCondProfiles "ERROR 32"
onCondString

Desciption

Used with “–onCondType” option. Indicates string to look for in slice application log. If string is found, execute action specified with “–onCondType” option.

Usage

Syntax: ... --onCondString <search-string>

Example: Submit 3DSMAX job and requeue any slice that has an application log that contains the "Error opening scene file:" string in it.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"
onCondType

Desciption

Used with “–onCondString” option to indicate what action to take if string specified by “–onCondString” option is found in application log file when slice completes.

Usage

Syntax: ... --onCondType <on-condition-type>

Possible optios are:

    Option          Description
    abort           Abort job slice and continue job
    complete        Mark job slice as completed
    error           Place job in error state
    ignore          Don't send any more slices to render node.
    requeue         Requeue job slice
    requeueDelay    Requeue jobs slice with delay. Use with "-- onCondDelay" option.

Example: Submit 3DSMAX job and requeue any slice that has an application log that contains the "Error opening scene file:" string in it.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"
outputDir

Desciption

Output folder for processed images

Usage

Syntax: ... --outputDir <output-path>

Example: Submit Maya software render job and place images in $XPATH(SQUIDDIR)\Images\PT-0001-temp folder.

sqn --submit --sceneName "MAYA-SW Test" --template maya --tileRequest  --tileRenderer "Software" --useRenderer Software --tileRows 10 --tileCols 10  --tileMode grid --tileRegions all --tileImagePrefix test_ --tileImageFmtIdx 1 --appPath $APP(MAYA-2014) --sceneFile "$XPATH(SQUIDDIR)\MayaProjects\SquidNet-Performance\scenes\SquidNet-Maya-Benchmark.mb"  --projectFolder $XPATH(SQUIDDIR)\MayaProjects\SquidNet-Performance --workDir $XPATH(SQUIDDIR)\MayaProjects\SquidNet-Performance\scenes --startFrame 1 --endFrame 1 --imageFilenameFormat name#.ext --priority 4 --outputDir $XPATH(SQUIDDIR)\Images\PT-0001-temp --imagePrefix test_$(REG_MASK) --pixelBound "$(REG_LEFT) $(REG_RIGHT) $(REG_BOTTOM) $(REG_TOP)" --imageWidth 1920 --imageHeight 1080 --imageFormat png --useAllCores
outputFile

Desciption

Specified output filename.

Usage

Syntax: ... --outputFile <output-file-path>

Example: : Archive S:\Images\0030-XSI-Fire-Ring folder to create E:\temp\0030-XSI-Fire-Ring.tar archive file.

sqn --pack S:\Images\0030-XSI-Fire-Ring --outputFile E:\temp\0030-XSI-Fire-Ring.tar
poolPrimaryAbort

Desciption

Used to abort any job slices that may be using the job’s primary pools. If not specified, the jobs that are using the primary pools are allowed to passively complete before the primary pools take precedence..

Usage

Syntax: ... --poolPrimaryAbort

Example: When this job is submitted, automatically abort any job slices that are using render pool "B".

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12 --onCondType requeueDelay --onCondString "Error opening scene file:"   --onCondProfiles "ERROR 32"
pools

Desciption

A comma-separated list of pool names to submit jobs to.

Usage

Syntax: ... --pools <pool-names>

Example: Submit 3DSMAX job to primary render pool A and use alternate render pool "B" if it's available.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12 --onCondType requeueDelay --onCondString "Error opening scene file:"   --onCondProfiles "ERROR 32"
poolsAlternate

Desciption

A comma-separated list of alternate pools to use. Alternate pools can be used if they’re not being used by other jobs.

Usage

Syntax: ... --poolsAlternate <pool-names>

Example: Submit 3DSMAX job to primary render pool A and use alternate render pool "B" if it's available.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12 --onCondType requeueDelay --onCondString "Error opening scene file:"   --onCondProfiles "ERROR 32"
priority

Desciption

Assign queue priority to job request. Priorty values range from 0 (highest) to 24 (lowest).

Usage

Syntax: ... --priority <number-value>

Example: Submit 3DSMAX job at priority 1.

sqn sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12 --onCondType requeueDelay --onCondString "Error opening scene file:"   --onCondProfiles "ERROR 32"
processingNodes

Desciption

A comma-separated list of node names that will render the job. If the “–include” option is specified (the default), the job will render ONLY on the listed nodes. If “–exclude” option is specified, DON’T render any slices on listed nodes.

Usage

Syntax: ... --processingNodes <node-list>

Example: On render Terragen job on nodes RENDERNODE12 and RENDERNODe13

sqn --submit --sceneName "TG Test" --template terragen --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 20 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\Images\terragen2 --outFilename water-space --outNumFormat 06 --outFormat bmp --useAllCores --sliceTimeoutMins 2 --jobSliceTimeoutError --errsBeforeStop 1 --include --processingNodes rendernode12,rendernode13

This command also supports the following options (similar to --node option):

    all             Apply command to all render farm nodes.
    master          Apply command to master node only.
    clients         Apply command to all client nodes.
    slaves          Apply command to all slave nodes.
    windows         Apply command to all Windows nodes.
    osx             Apply command to all Mac OS nodes.
    linux           Apply command to all Linux nodes.
    <pool-name>     Apply command to all nodes that belong to specified pools.
    <node-name>     Apply command to specified node names.

-----------------------------------------------------------------------------------------

Example: Render Terragen job on every node except RENDERNODE12 and RENDERNODe13

sqn --submit --sceneName "TG Test" --template terragen --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 20 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\Images\terragen2 --outFilename water-space --outNumFormat 06 --outFormat bmp --useAllCores --sliceTimeoutMins 2 --jobSliceTimeoutError --errsBeforeStop 1 --exclude --processingNodes rendernode12,rendernode13
projectName

Desciption

Specifies project folder.

Usage

Syntax: ... --projectName <project-folder>

Example:  Submit job and same into project folder ACME

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12 --onCondType requeueDelay --onCondString "Error opening scene file:"   --onCondProfiles "ERROR 32" --projectName ACME

To resubmit the same job later do:

sqn --submit --jobId maxJob#1  --projectName ACME
projectPath

Desciption

Specifies a project’s parent folder. If not specifed, defaults to SquidNet configuration path.

Usage

Syntax: ... --projectPath <project-folder>

Example: Submit job request maxJob#1 from ACME project in S:\SquidNetConfig\projects-dir folder.

sqn --submit --jobId maxJob#1  --projectName ACME --projectPath S:\SquidNetConfig\projects-dir
randomJobslices

Desciption

Used to randomize the processing of job slices. By default, all job slices are rendereed sequentially (according to frame number)

Usage

Syntax: ... --randomJobslices

Example: Randomize job slices.

sqn --submit --jobId maxJob#1  --projectName TEST2 --randomJobslices
saveOnly

Desciption

Used with “–projectName” to save job request to specified folder without submitting to render farm queue.

Usage

Syntax: ... --saveOnly

Example:

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12 --onCondType requeueDelay --onCondString "Error opening scene file:"   --onCondProfiles "ERROR 32" --projectName ACME --saveOnly
sceneFile

Desciption

Specifies path of scene file to render.

Usage

Syntax: ... --sceneFile <path-to-scene-file>

Example: Submit 3DSMAX job request.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12
sceneName

Desciption

Specifies name of shot that job belongs to. If specified, job will be organanized under shot name in GUI. If not specifed, the default shot name is “DefaultScene”.

Usage

Syntax: ... --sceneName <shot-name>

Example: Submit 3DSMAX job request.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12
showDependencies

Desciption

Lists jobs that specified job is dependent on.

Usage

Syntax: ... --showDependencies <job-id>

Example: Show dependencies for job id #13023

sqn --jobId #13023 --showDependencies
skipPresentFrames

Desciption

If specified, don’t re-render any frames that already exist in output folder.

Usage

Syntax: ... --skipPresentFrames

Example: submit 3DSMAX job but don't render any existing frames.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12 --skipPresentFrames
sliceScriptPrePath

Desciption

Execeute script before each slice starts processing.

Usage

Syntax: ... --sliceScriptPrePath <<network-path>

Example: Run test.bat script before/after job starts/ends processing and before/after jobslice starts/ends processing.

sqn --netVerTest --startFrame 1 --endFrame 1 --jobScriptPrePath S:\Scripts\test.bat --jobScriptPostPath S:\Scripts\test.bat --sliceScriptPrePath S:\Scripts\test.bat --sliceScriptPostPath S:\Scripts\test.bat

Same command using translation path:

sqn --netVerTest --startFrame 1 --endFrame 1 --jobScriptPrePath $XPATH(SCRIPTS)\test.bat --jobScriptPostPath $XPATH(SCRIPTS)\test.bat --sliceScriptPrePath $XPATH(SCRIPTS)\test.bat --sliceScriptPostPath $XPATH(SCRIPTS)\test.bat
sliceScriptPostPath

Desciption

Execeute script when each job slice successfully completes processing.

Usage

Syntax: ... --sliceScriptPostPath <network-path>

Example: Run test.bat script before/after job starts/ends processing and before/after jobslice starts/ends processing.

sqn --netVerTest --startFrame 1 --endFrame 1 --jobScriptPrePath S:\Scripts\test.bat --jobScriptPostPath S:\Scripts\test.bat --sliceScriptPrePath S:\Scripts\test.bat --sliceScriptPostPath S:\Scripts\test.bat

Same command using translation path:

sqn --netVerTest --startFrame 1 --endFrame 1 --jobScriptPrePath $XPATH(SCRIPTS)\test.bat --jobScriptPostPath $XPATH(SCRIPTS)\test.bat --sliceScriptPrePath $XPATH(SCRIPTS)\test.bat --sliceScriptPostPath $XPATH(SCRIPTS)\test.bat
sliceStallLimit

Desciption

Requeues job slice if it appears to be “stuck”. SquidNet will auto-requeue slice if the application log does not change for the time specifeid.

Usage

Syntax: ... --sliceStallLimit <minutes>

Example: Auto-requeue any job slice that stalls for more than 20 minutes.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12 --sliceStallLimit 20
sliceTimeoutMins

Desciption

Sets the maximum time that a job slice is allowed to process. If time is exceeded, the slice is automatically requeued..

Usage

Syntax: ... --sliceTimeoutMins <minutes>

Example: Auto-requeue any job slice that doesn't complete within 45 minutes.

sqn sqn --submit --sceneName "TG Test" --template terragen --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 20 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\Images\terragen2 --outFilename water-space --outNumFormat 06 --outFormat bmp --useAllCores --sliceTimeoutMins 45 --jobSliceTimeoutError --errsBeforeStop 1 --maxJobslices 20 --include --processingNodes rendernode12 --minMemAbort 5 --minMemPct 80 --minMemRemember --notes "This is a note"
sliceTimeoutMux

Desciption

Sets the maximum time that a job slice is allowed to process. The time is based on the average of previous jobslices multipled by the value specified.

For example, if “– sliceTimeoutMux 10” is specified and job slices 1 thru 10 complete in 10 minutes, then the maximum time before any job slices are requeued will be (10x10mins) == 100 mins ( 1hr 40 mins).

Usage

Syntax: ... --sliceTimeoutMux <multiplier>

Example:

sqn --submit --sceneName "TG Test" --template terragen --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 20 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\Images\terragen2 --outFilename water-space --outNumFormat 06 --outFormat bmp --useAllCores --sliceTimeoutMux 10 --jobSliceTimeoutError --errsBeforeStop 1 --maxJobslices 20 --include --processingNodes rendernode12 --minMemAbort 5 --minMemPct 80 --minMemRemember --notes "This is a note"
smsFlags

Desciption

SMS notification options.

Usage

Syntax: ... --smsFlags <options>

Available options:

    enabled         Enable SMS notifications
    jobStart        Send SMS notification when job starts
    jobErr          Send SMS notification when job goes into an error state
    jobEnd          Send SMS notification when job completes
    jobCancelled    Send SMS notification when job is cancelled
    jobsliceErr     Send SMS notification when job a jobslice goes into an error state
    jobsSuspended   Send SMS notification when job is suspended
    jobResumed      Send SMS notification when job is resumed


Example: Submit 3DSMAX jobs and send SMS notifications

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12 --sliceStallLimit 20 --smsFlags enabled,jobStart --smsRecipients 7146092928@txt.att.net
smsRecipients

Desciption

Command separated list of SMS text recipients. .

Usage

Syntax: ... --smsRecipients <list-of-recipients>

Example: Submit 3DSMAX jobs and send SMS notifications

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12 --sliceStallLimit 20 --smsFlags enabled,jobStart --smsRecipients 5124445555@txt.att.net
soundJobDone

Desciption

Play sound notification when job completes.

Usage

Syntax: ... --soundJobDone

Example: Play sound clips for job events.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12 --sliceStallLimit 20 --soundJobDone --soundJobError --soundJobSliceDone --soundJobSliceError
soundJobError

Desciption

Play sound notification when job errors out

Usage

Syntax: ... --soundJobError

Example: Play sound clips for job events.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12 --sliceStallLimit 20 --soundJobDone --soundJobError --soundJobSliceDone --soundJobSliceError
soundJobSliceDone

Desciption

Play sound notification when job slices complete

Usage

Syntax: ... --soundJobSliceDone

Example: Play sound clips for job events.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12 --sliceStallLimit 20 --soundJobDone --soundJobError --soundJobSliceDone --soundJobSliceError
soundJobSliceError

Desciption

Play sound notification when job slices error out.

Usage

Syntax: ... --soundJobSliceError

Example: Play sound clips for job events.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12 --sliceStallLimit 20 --soundJobDone --soundJobError --soundJobSliceDone --soundJobSliceError
sourceNode

Desciption

Specifies name of node that submitted job. If not specified, defaults to submitting node.

Usage

Syntax: ... --sourceNode <nodename>

Example:

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12 --sliceStallLimit 20 --sourceNode HURRICANE
startFrame

Desciption

Specifies the start frame of an animation render.

Usage

Syntax: ... --startFrame <frame-num>

Example: Render frames 1 thru 20

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 2 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"  --appLog 4000 --checkOutputContent --clearOutputDir --moveFolder S:\Images\save
startSuspended

Desciption

Submit suspended job to render farm queue.

Usage

Syntax: ... --startSuspended

Example: Submit job to render farm queue but leave suspended until manually resumed.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --stepFrame 5 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12 --sliceStallLimit 20  --startSuspended
stepFrame

Desciption

Specifies the frame increment between starting and ending frames. Defaults to “1” if not specifeid.

Usage

Syntax: ... --stepFrame <frame-interval>

Example: Submit job to render every 5th frame.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --stepFrame 5 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --poolPrimaryAbort --notifyOptions all --include --processingNodes rendernode12 --sliceStallLimit 20
submit

Desciption

Used to submit multi-frame scene renders to job queue.

Usage

Syntax: ... --submit <options>

Example: Queue a generic job and execute batch script "S:/logs/setup_maya.bat" on node RENDERNODE03

sqn --submit --template generic  --appPath S:/logs/setup_maya.bat --additionalFlags "mr vray renderman" --compAction leave --include --processingNodes RENDERNODE03

Example: Add 3DSMAX job maxJob#1 to render queue.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 1  --startFrame 1 --endFrame 20 --framePerSlice 1 --useAllCores --pools A --poolsAlternate B --notifyOptions all --include --processingNodes rendernode12 --onCondType requeue --onCondString "Error opening scene file:"
tileCols

Desciption

Specifies the number of columns in a tile render request.

Usage

Syntax: ... --tileCols <numberic-value>

Example: Submit Terragen tile render request.

sqn --submit --sceneName "TG Test" --template terragen --tileRequest --tileRenderer "terragen" --tileRows 10 --tileCols 10  --tileMode grid --tileRegions all --tileImagePrefix water-space --tileImageFmtIdx 1 --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 1 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\terragen2 --outFilename water-space$(REG_MASK) --imageWidth 1280 --imageHeight 720 --outNumFormat 06 --outFormat tif --useAllCores --include --processingNodes alvserver-ofc,rendernode12,rendernode11,rendernode08
tileImageFmtIdx

Desciption

Tile render image format index.

Usage

Syntax: ... --tileImageFmtIdx <index>

Example: Submit Terragen tile render request.

sqn --submit --sceneName "TG Test" --template terragen --tileRequest --tileRenderer "terragen" --tileRows 10 --tileCols 10  --tileMode grid --tileRegions all --tileImagePrefix water-space --tileImageFmtIdx 1 --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 1 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\terragen2 --outFilename water-space$(REG_MASK) --imageWidth 1280 --imageHeight 720 --outNumFormat 06 --outFormat tif --useAllCores --include --processingNodes alvserver-ofc,rendernode12,rendernode11,rendernode08
tileImagePrefix

Desciption

Image prefix for tile render images.

Usage

Syntax: ... --tileImagePrefix <image-prefix>

Example: Submit tile render job and prefix images with "water-space".

sqn --submit --sceneName "TG Test" --template terragen --tileRequest --tileRenderer "terragen" --tileRows 10 --tileCols 10  --tileMode grid --tileRegions all --tileImagePrefix water-space --tileImageFmtIdx 1 --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 1 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\terragen2 --outFilename water-space$(REG_MASK) --imageWidth 1280 --imageHeight 720 --outNumFormat 06 --outFormat tif --useAllCores --include --processingNodes alvserver-ofc,rendernode12,rendernode11,rendernode08
tileMode

Desciption

Tiling mode for tile render job. .

Usage

Syntax: ... --tileMode <tiling-mode>

Example: Submit Terragen tile render request.

sqn --submit --sceneName "TG Test" --template terragen --tileRequest --tileRenderer "terragen" --tileRows 10 --tileCols 10  --tileMode grid --tileRegions all --tileImagePrefix water-space --tileImageFmtIdx 1 --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 1 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\terragen2 --outFilename water-space$(REG_MASK) --imageWidth 1280 --imageHeight 720 --outNumFormat 06 --outFormat tif --useAllCores --include --processingNodes alvserver-ofc,rendernode12,rendernode11,rendernode08
tileRegions

Desciption

Regions to render in tile render job.

Usage

Syntax: ... --tileRegions <tiling-regions>

Example: Submit Terragen tile render request.

sqn --submit --sceneName "TG Test" --template terragen --tileRequest --tileRenderer "terragen" --tileRows 10 --tileCols 10  --tileMode grid --tileRegions all --tileImagePrefix water-space --tileImageFmtIdx 1 --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 1 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\terragen2 --outFilename water-space$(REG_MASK) --imageWidth 1280 --imageHeight 720 --outNumFormat 06 --outFormat tif --useAllCores --include --processingNodes alvserver-ofc,rendernode12,rendernode11,rendernode08
tileRemove

Desciption

If specified, remove all tile images. Does not remove final stitched image.

Usage

Syntax: ... --tileRemove

Example: Submit 3DSMAX tile render request and remove tile images when done.

sqn --submit --sceneName "3DSMAX Test" --template 3dsmax --tileRequest --tileRenderer "3dsmax" --tileRows 10 --tileCols 1  --tileMode grid --tileRegions all --tileImagePrefix test_ --tileImageFmtIdx 1 --appPath $APP(3DSMAX-64BIT-2013) --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max"  --frameList 1,2,4,6,9,15-18 --priority 4 --outputDir $XPATH(SQUIDDIR)\Images\radiosity --imagePrefix test_ --imageWidth 1280 --imageHeight 720 --imageFormat "PNG Image File" --useAllCores --pools A --compAction leave --createOutputDir --tileRemove
tileRenderer

Desciption

Specifies which renderer to use in tiling request.

Usage

Syntax: ... --tileRenderer <renderer-name>

Example: Submit Maya tile render request and use V-Ray renderer.

sqn --submit --sceneName "MAYA-VRAY Test" --template maya --tileRequest  --tileRenderer "V-Ray" --useRenderer V-Ray --tileRows 10 --tileCols 10  --tileMode grid --tileRegions all --tileImagePrefix test_ --tileImageFmtIdx 1 --appPath $APP(MAYA-2011) --sceneFile "$XPATH(SQUIDDIR)\MayaProjects\SquidNet-Performance\scenes\SquidNet-Maya-Benchmark.mb"  --projectFolder $XPATH(SQUIDDIR)\MayaProjects\SquidNet-Performance --workDir $XPATH(SQUIDDIR)\MayaProjects\SquidNet-Performance\scenes --startFrame 1 --endFrame 1 --imageFilenameFormat name#.ext --priority 4 --outputDir $XPATH(SQUIDDIR)\Images\PT-0001-temp --imagePrefix test_$(REG_MASK) --pixelBound "$(REG_LEFT) $(REG_RIGHT) $(REG_BOTTOM) $(REG_TOP)" --imageWidth 1920 --imageHeight 1080 --imageFormat png --useAllCores --include --processingNodes rendernode12
tileRequest

Desciption

Keyword for tile render request.

Usage

Syntax: ... --tileRequest

Example: Submit Maya tile render request and use V-Ray renderer.

sqn --submit --sceneName "MAYA-VRAY Test" --template maya --tileRequest  --tileRenderer "V-Ray" --useRenderer V-Ray --tileRows 10 --tileCols 10  --tileMode grid --tileRegions all --tileImagePrefix test_ --tileImageFmtIdx 1 --appPath $APP(MAYA-2011) --sceneFile "$XPATH(SQUIDDIR)\MayaProjects\SquidNet-Performance\scenes\SquidNet-Maya-Benchmark.mb"  --projectFolder $XPATH(SQUIDDIR)\MayaProjects\SquidNet-Performance --workDir $XPATH(SQUIDDIR)\MayaProjects\SquidNet-Performance\scenes --startFrame 1 --endFrame 1 --imageFilenameFormat name#.ext --priority 4 --outputDir $XPATH(SQUIDDIR)\Images\PT-0001-temp --imagePrefix test_$(REG_MASK) --pixelBound "$(REG_LEFT) $(REG_RIGHT) $(REG_BOTTOM) $(REG_TOP)" --imageWidth 1920 --imageHeight 1080 --imageFormat png --useAllCores --include --processingNodes rendernode12
tileRows

Desciption

Specifies the number of rows in a tile render request.

Usage

Syntax: ... --tileRows <numberic-value>

Example: Submit Terragen tile render request.

sqn --submit --sceneName "TG Test" --template terragen --tileRequest --tileRenderer "terragen" --tileRows 10 --tileCols 10  --tileMode grid --tileRegions all --tileImagePrefix water-space --tileImageFmtIdx 1 --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 1 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\terragen2 --outFilename water-space$(REG_MASK) --imageWidth 1280 --imageHeight 720 --outNumFormat 06 --outFormat tif --useAllCores --include --processingNodes alvserver-ofc,rendernode12,rendernode11,rendernode08
useAllCores

Desciption

If specified, job slice will use all available cores on processing nodes.

Usage

Syntax: ... --useAllCores

Example: Submit Terragen request.

sqn --submit --sceneName "TG Test" --template terragen --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 20 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\Images\terragen2 --outFilename water-space --outNumFormat 06 --outFormat bmp --useAllCores --sliceTimeoutMins 200 --jobSliceTimeoutError --errsBeforeStop 1 --maxJobslices 20 --include --processingNodes rendernode12 --minMemAbort 5 --minMemPct 80 --minMemRemember --notes "This is a note"
username

Desciption

Specifies owner of job quest. If not specified, defaults to submiting user.

Usage

Syntax: ... --username <user-name>

Example:

sqn --submit --sceneName "TG Test" --template terragen --appPath $APP(TERRAGEN) --sceneFile "S:\Terragen2\Open Water Animation Tests 3.tgd" --startFrame 1 --endFrame 20 --priority 4 --outputDir \\raid-server00\volume_1\SquidNet\Images\Images\terragen2 --outFilename water-space --outNumFormat 06 --outFormat bmp --useAllCores --sliceTimeoutMins 200 --jobSliceTimeoutError --errsBeforeStop 1 --maxJobslices 20 --include --processingNodes rendernode12 --minMemAbort 5 --minMemPct 80 --minMemRemember --notes "This is a note" --username "Fred Flinstone"
videoEnable

Desciption

Enable the creation of a video file from a completed multi-frame animation.

Usage

Syntax: ... --videoEnable

Example: Submit 3DSMAX render job and create H.264 video from image sequence.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT-2013) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 10  --startFrame 1 --endFrame 1   --skipPresentFrames --useAllCores --notifyOptions all  --onCondType requeue --onCondString "Error opening scene file:" --videoEnable --videoFrameRate "60 fps"  --videoOutputDir S:\Images\videos --videoPlay --videoResolution "hd720(1280x720)" --videoRenderNode THOR --videoPriority 3
videoFrameRate

Desciption

Specifies video frame rate.

Usage

Syntax: ... --videoFrameRate <frame-rate>

Example: Create 60fps video file from image sequence.

sqn --submit --template ffmpeg --appPath ffmpeg --inputDir "S:\Images\#0012-City-Car-Animation MACRO" --outputDir S:\Images\videos --videoFrameRate "60 fps" --videoResolution "hd720(1280x720)" --include --processingNode thor --useAllCores
videoOutputDir

Desciption

Specifies output folder of created video file. The name of the video file will be prefix of the image seqence files.

Usage

Syntax: ... --videoOutputDir <output-path>

Example: Submit 3DSMAX render job and create H.264 video from image sequence.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT-2013) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 10  --startFrame 1 --endFrame 1   --skipPresentFrames --useAllCores --notifyOptions all  --onCondType requeue --onCondString "Error opening scene file:" --videoEnable --videoFrameRate "60 fps"  --videoOutputDir S:\Images\videos --videoPlay --videoResolution "hd720(1280x720)" --videoRenderNode THOR --videoPriority 3
videoPriority

Desciption

The job to create the video file is added to the render farm job queue. Specify the priority that video job to be between 0 and 24.

Usage

Syntax: ... --videoPriority <priority>

Example: Submit 3DSMAX render job and create H.264 video from image sequence.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT-2013) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 10  --startFrame 1 --endFrame 1   --skipPresentFrames --useAllCores --notifyOptions all  --onCondType requeue --onCondString "Error opening scene file:" --videoEnable --videoFrameRate "60 fps"  --videoOutputDir S:\Images\videos --videoPlay --videoResolution "hd720(1280x720)" --videoRenderNode THOR --videoPriority 3
videoRenderNode

Desciption

Specifiy the name of the node that will process the video creation request. If not specified, the master will select the next available render node.

Usage

Syntax: ... --videoRenderNode <node-name>

Example: Submit 3DSMAX render job and create H.264 video from image sequence.

sqn --submit --template 3dsmax --appPath $APP(3DSMAX-64BIT-2013) --jobId maxJob#1 --sceneName Shot_001 --sceneFile "$XPATH(SQUIDDIR)\\3DSMaxProjects\Scenes\AdvancedLighting\radiosity.max" --createOutputDir --outputDir $XPATH(SQUIDDIR)\Images\radiosity1 --imagePrefix test_ --imageFormat  "PNG Image File" --imageSize "VGA (640 x 480)"  --priority 10  --startFrame 1 --endFrame 1   --skipPresentFrames --useAllCores --notifyOptions all  --onCondType requeue --onCondString "Error opening scene file:" --videoEnable --videoFrameRate "60 fps"  --videoOutputDir S:\Images\videos --videoPlay --videoResolution "hd720(1280x720)" --videoRenderNode THOR --videoPriority 3
videoResolution

Desciption

Specifies video output resolution.

Usage

Syntax: ... --videoResolution <resolution-format>

Example: Create 1280x720 HD video from image sequence.

sqn --submit --template ffmpeg --appPath ffmpeg --inputDir "S:\Images\#0012-City-Car-Animation MACRO" --outputDir S:\Images\videos --videoFrameRate "60 fps" --videoResolution "hd720(1280x720)" --include --processingNode thor --useAllCores
workDir

Desciption

Specifies working directory for rendering application.

Usage

Syntax: ... --workDir <path>

Example: Submit Maya tile render request and specify that each job slice only use 2 cores.

sqn --submit --sceneName "MAYA-MR Test" --template maya --tileRequest  --tileRenderer "MentalRay" --useRenderer MentalRay --tileRows 10 --tileCols 10  --tileMode grid --tileRegions all --tileImagePrefix test_ --tileImageFmtIdx 1 --appPath $APP(MAYA-2014) --sceneFile "$XPATH(SQUIDDIR)\MayaProjects\SquidNet-Performance\scenes\SquidNet-Maya-Benchmark.mb"  --projectFolder $XPATH(SQUIDDIR)\MayaProjects\SquidNet-Performance --workDir $XPATH(SQUIDDIR)\MayaProjects\SquidNet-Performance\scenes --startFrame 1 --endFrame 1 --imageFilenameFormat name#.ext --priority 4 --outputDir $XPATH(SQUIDDIR)\Images\PT-0001-temp --imagePrefix test_$(REG_MASK) --pixelBound "$(REG_LEFT) $(REG_RIGHT) $(REG_BOTTOM) $(REG_TOP)" --imageWidth 1920 --imageHeight 1080 --imageFormat png --numThreads 2