Deadline CLI Reference¶
deadline bundle¶
Commands to work with Open Job Description job bundles. Use these commands to submit jobs to run on a Deadline Cloud queue.
Usage:
deadline bundle [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
gui-submit¶
Opens a GUI to submit an Open Job Description job bundle to a Deadline Cloud queue. You can provide options to set the initial parameter values shown in the GUI.
Usage:
deadline bundle gui-submit [OPTIONS] [JOB_BUNDLE_DIR]
Options:
-p, --parameter TEXT Initial values in the GUI for the job template's
parameters. Can be provided as key-value pairs,
inline JSON strings, or as paths to a JSON or YAML
document. Later values for repeated parameter names
take precedence. Examples: --parameter MyParam=5 -p
file://parameter_file.json -p '{"OtherParam":
"10"}'
--browse Opens a folder browser to select a bundle.
--install-gui Installs GUI dependencies if they are not installed
already
--submitter-name TEXT Name of the application submitting the bundle. If a
name is specified, the GUI will automatically close
after submitting the job.
--output [verbose|json] Specifies the output format of the messages printed
to stdout. VERBOSE: Displays messages in a human-
readable text format. JSON: Displays messages in
JSON line format, so that the info can be easily
parsed/consumed by custom scripts.
--known-asset-path TEXT Path that should not generate warnings when outside
storage profile locations. Can be specified
multiple times for different paths.
--help Show this message and exit.
submit¶
Submits an Open Job Description job bundle to a Deadline Cloud queue. You can provide options to set parameter values, the job name, priority, and more.
Usage:
deadline bundle submit [OPTIONS] JOB_BUNDLE_DIR
Options:
-p, --parameter TEXT The values for the job template's
parameters. Can be provided as key-value
pairs, inline JSON strings, or as paths to a
JSON or YAML document. Later values for
repeated parameter names take precedence.
Examples: --parameter MyParam=5 -p
file://parameter_file.json -p
'{"OtherParam": "10"}'
--profile TEXT The AWS profile to use.
--farm-id TEXT The farm to use.
--queue-id TEXT The queue to use.
--storage-profile-id TEXT The storage profile to use.
--name TEXT The job name to use in place of the one in
the job bundle.
--priority INTEGER The priority of the job. Jobs with a higher
priority run first.
--max-failed-tasks-count INTEGER
The maximum number of failed tasks before
the job is marked as failed.
--max-retries-per-task INTEGER The maximum number of times to retry a task
before it is marked as failed.
--max-worker-count INTEGER The max worker count of the job.
--target-task-run-status [ready|suspended]
The target task run status for the job.
READY means tasks will start immediately,
SUSPENDED means tasks will be created but
not start until manually resumed.
--job-attachments-file-system [COPIED|VIRTUAL]
The method workers use to access job
attachments. COPIED means to copy files to
the worker and VIRTUAL means to load files
as needed from a virtual file system. If
VIRTUAL is selected but not supported by a
worker, it will fallback to COPIED.
--yes Automatically accept any confirmation
prompts
--require-paths-exist Return an error if any input files are
missing.
--submitter-name TEXT Name of the application submitting the
bundle.
--known-asset-path TEXT Path that should not generate warnings when
outside storage profile locations. Can be
specified multiple times for different
paths.
--save-debug-snapshot TEXT EXPERIMENTAL - Instead of submitting the
job, generate a debug snapshot as a
directory or a zip file if the extension is
.zip. It includes the job attachments and
parameters for creating the job. You can
later run the bash script in the snapshot to
submit the job using AWS CLI commands.
--help Show this message and exit.