Skip to content

Deadline CLI Reference

deadline auth

Commands to handle authentication, such as logging in to Deadline Cloud monitor.

Usage:

deadline auth [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

login

Opens Deadline Cloud monitor to log in to your farm. Supports profiles created by Deadline Cloud monitor.

Usage:

deadline auth login [OPTIONS]

Options:

  --help  Show this message and exit.

logout

Logs out of the configured AWS profile, if it was created by Deadline Cloud monitor.

Usage:

deadline auth logout [OPTIONS]

Options:

  --help  Show this message and exit.

status

Gets the status of the selected AWS profile, including its name, whether it was created by Deadline Cloud monitor, and whether Deadline Cloud APIs are accessible.

Usage:

deadline auth status [OPTIONS]

Options:

  --profile TEXT           The AWS profile to use.
  --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.
  --help                   Show this message and exit.