Options for the cmdjob Utility
 
 
 

This section describes the options you can use with the cmdjob command.

Options

Option Description
-? Displays the help for the cmdjob utility.
-cmdFile:<file>;<file>... or @<file>;<file>... Specifies one or more text files that contain options to the cmdjob utility.

Job Options

Option Description
-jobName:<name> Sets the job name. The default is “cmdJob”.
-description:<string> Defines a description of the job.
-priority:<number> Sets the job priority. The default value is 50. The other values are either 0 (Critical) or 100 (Suspended).
-workPath [folder] Working folder or directory for the cmdjob utility. The default value is “…\backburner\Network\ServerJob” folder. This path is set before the cmdjob utility interprets processing options for a job. This path is also set as the working path for servers. If the working folder is not set, the full path to the executable and target files must be specified when submitting the job.
-logPath:<folder> Specifies the location of the folder or directory in which the task logs are created. This location must specify an existing folder, since the command line utility cannot create this folder if it does not exist. This option is disabled by default.
-showOutput<file>;<file>;... Makes the specified output files accessible from the Backburner Monitor or Web Monitor.

Job Submission Options

Option Description
-dependencies:<jobname>;<jobname>;<jobname>;... Defines a list of job dependencies.
-timeout:<minutes> Number of minutes before a task time-out should occur. Default value is 60 minutes.
-attach Attaches the batch file to the job as a .zip file. The batch file is then extracted on each machine before the job is processed.
-progress Shows the progress of the job in the shell as it is being processed.
-suspended Sets the status of the job to suspended.
-userRights Runs cmdjob jobs with the account name (hence, user permissions) of the account submitting the job. If this option is not specified, jobs are run as root.

Requires that the UserCmdjobAdapter adapter is installed on the render nodes.

Network Options

Option Description
-manager:<name> Sets the name of the manager. The default is an automatic search.
-port:<number> Sets the port number.
-servers:<server>;<server>;... Defines the set of servers to which the job is submitted. Ignored if a server group is specified using -group.
-serverCount:<number> Sets the maximum number of servers that can simultaneously work on the job.
-group:<string> Defines the server group to which the job is submitted.

Notification Options

Option Description
-emailFrom:<address> Sets the source email address for notification emails.
-emailTo:<address> Sets the destination email address for notification emails.
-emailServer:<server> Sets the name of the SMTP email server Backburner uses to send notification emails.
-emailCompletion Sends a notification email when the job is completed.
-emailFailure Sends a notification email if the job fails.
-emailProgress:<number> Sends a notification email when the number of tasks that you set are completed.