Deadline CLI Reference

deadline queue

Manage Deadline Cloud queues. View queue details, list available queues, export queue credentials for scripting, inspect queue parameter definitions, or sync job output for all jobs in a queue.

Learn more about queues

Usage:

deadline queue [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

export-credentials

Export queue credentials in a format compatible with the AWS SDK credential_process setting.

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.

Learn more about credential_process

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 only the queues you have permission to access.

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.

Learn more about queue environments

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 attachment output for all jobs in a Deadline Cloud queue since the last run of the same command.

On first run (or with --force-bootstrap), downloads from --bootstrap-lookback-minutes in the past. On subsequent runs, it resumes from the previous checkpoint.

By default, requires a storage profile (for path mapping across OS/mount differences). Use --ignore-storage-profiles if you always submit and download from the same machine.

Learn more about automatic downloads

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.
  --dry-run                       Perform a dry run of the operation, don't
                                  actually download the output files.
  --help                          Show this message and exit.