Deadline CLI Reference¶
deadline queue¶
Commands to work with Deadline Cloud queues.
Usage:
deadline queue [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
export-credentials¶
Export queue credentials in a format compatible with AWS SDK credentials_process.
These credentials assume the service role of a Deadline Cloud queue and give access to resources needed for creating and running jobs like the job attachments S3 bucket and any other resources authorized by the role.
Usage:
deadline queue export-credentials [OPTIONS]
Options:
--queue-id TEXT The queue ID to use.
--farm-id TEXT The farm ID to use.
--mode [user|read] The type of queue role to assume (default:
USER)
--output-format [credentials_process]
Format of the output (default:
credentials_process)
--profile TEXT The AWS profile to use.
--help Show this message and exit.
get¶
Get the details of a Deadline Cloud queue in the farm.
Usage:
deadline queue get [OPTIONS]
Options:
--profile TEXT The AWS profile to use.
--farm-id TEXT The farm to use.
--queue-id TEXT The queue to use.
--help Show this message and exit.
list¶
Lists the available Deadline Cloud queues in the farm. If the AWS profile is created from a Deadline Cloud monitor login, it will list the queues you have permission to access, otherwise it will list all queues.
Usage:
deadline queue list [OPTIONS]
Options:
--profile TEXT The AWS profile to use.
--farm-id TEXT The farm to use.
--help Show this message and exit.
paramdefs¶
Lists the parameter definitions for a Deadline Cloud queue in the farm.
The parameter definitions include all the parameters defined by the queue environments configured for the queue.
Usage:
deadline queue paramdefs [OPTIONS]
Options:
--profile TEXT The AWS profile to use.
--farm-id TEXT The farm to use.
--queue-id TEXT The queue to use.
--help Show this message and exit.
sync-output¶
Downloads any new job attachments output for all jobs in a Deadline Cloud queue since the last run of the same command. You can use this command to configure automatic downloads for your queue.
When run for the first time or with the --force-bootstrap option, it starts downloading from --bootstrap-lookback-minutes in the past. When run each subsequent time, it loads the previous checkpoint and continues where it left off.
With default options, the sync-output operation requires a storage profile defined in the deadline client configuration or provided with the --storage-profile-id option. Storage profiles are used to generate path mappings when a job was submitted from a machine with a different operating system or file system mount locations than the machine downloading outputs.
If you only submit and download jobs from the same operating system and mount locations, you can use the --ignore-storage-profiles option.
Usage:
deadline queue sync-output [OPTIONS]
Options:
--profile TEXT The AWS profile to use.
--farm-id TEXT The AWS Deadline Cloud Farm to use.
--queue-id TEXT The AWS Deadline Cloud Queue to use.
--storage-profile-id TEXT The storage profile to use for mapping paths
to local. Cannot be used together with
--ignore-storage-profiles
--json Output is printed as JSON for scripting.
--bootstrap-lookback-minutes FLOAT
Downloads outputs for job-session-actions
that have been completed since these many
minutes at bootstrap. Default value is 0
minutes.
--checkpoint-dir TEXT Proceed downloading from the previous
progress file stored in this directory, if
it exists. If the file does not exist, the
download will initialize using the bootstrap
lookback in minutes.
--force-bootstrap Forces command to start from the bootstrap
lookback period and overwrite any previous
checkpoint. Default value is False.
--ignore-storage-profiles Ignores the storage profile configuration.
Only use if all jobs in the queue are
submitted and downloaded from the same
machine. Downloads all jobs to unmapped
paths regardless of operating system.
Default value is False.
--conflict-resolution [skip|overwrite|create_copy]
How to handle downloads if an output file
already exists: CREATE_COPY: Download the
file with a new name, appending '(1)' to the
end SKIP: Do not download the file OVERWRITE
(default): Download and replace the existing
file. Default behaviour is to OVERWRITE.
--dry-run Perform a dry run of the operation, don't
actually download the output files.
--help Show this message and exit.