Deadline 10.4

https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/
Admin
Deadline is a render queue management and job scheduling software for distributed rendering across...
Tokens:580,350
Snippets:5,146
Trust Score:9.7
Update:7 months ago
Show doc for...
Tokens:
Raw
### Deadline Installation Path Example with Spaces

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/install-client.html

This example demonstrates how to properly encapsulate installation paths containing spaces using quotation marks. This is crucial for ensuring that the installer correctly interprets paths with spaces, preventing installation errors.

```bash
--prefix "C:\Program Files\Thinkbox\Deadline<VERSION>" --repositorydir "\\network path\with spaces\in it"
```

--------------------------------

### Install Linux Libraries with APT (Ubuntu)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/install-client.html

Example commands using APT to install required libraries for Deadline on Ubuntu systems. This includes LSB, X11, Xext, and OpenGL libraries for workstations.

```bash
sudo -s

# WORKSTATIONS
apt-get install lsb libx11-6 libxext-6 libgl1-mesa-6
```

--------------------------------

### Advanced Silent Installation Example (Windows)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/install-submitters.html

A comprehensive batch script demonstrating unattended installation of multiple Deadline submitters on Windows. It showcases the use of --enable-components, --disable-components, and --destDir options for granular control over component installation and destination paths. This script automates the installation of Maya, 3ds Max, and Nuke submitters with specific configurations.

```batch
@echo off
.\Maya-submitter-windows-installer.exe --mode unattended --disable-components Maya2014
.\3dsMax-submitter-windows-installer.exe --mode unattended
    --enable-components 3dsMax2011,3dsMax2015
    --disable-components 3dsMax2012,3dsMax2013,3dsMax2014
    --destDir2011 "C:\3dsMax2011_64"
.\Nuke-submitter-windows-installer.exe --mode unattended

```

--------------------------------

### Install Linux Libraries with YUM (RedHat/CentOS)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/install-client.html

Example commands using YUM to install necessary libraries for Deadline on RedHat/CentOS systems. This includes LSB, X11, Xext, and OpenGL libraries for both workstations and render nodes.

```bash
sudo -s

# WORKSTATIONS
yum install redhat-lsb libX11 libXext
# old version
yum install libMesaGL1
# new version
yum install mesa-libGL mesa-libGLU

# RENDERNODES
yum install redhat-lsb
```

--------------------------------

### Manage Deadline Launcher Service on Windows

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/launcher.html

Commands to install, uninstall, start, and stop the Deadline Launcher service. Installation can include starting the service automatically and specifying user credentials, optionally pulling passwords from environment variables.

```bash
InstallLauncherService [true/false]
InstallLauncherServiceLogOn [User Name] [Password] [true/false]
UninstallLauncherService
StartLauncherService
StopLauncherService
```

```bash
deadlinecommand.exe -InstallLauncherService
deadlinecommand.exe -InstallLauncherService true
deadlinecommand.exe -InstallLauncherServiceLogOn "USER" "env:PASSWORD" true
deadlinecommand.exe -UninstallLauncherService
deadlinecommand.exe -StartLauncherService
deadlinecommand.exe -StopLauncherService
```

--------------------------------

### Get Help for Deadline Submitter Installer (macOS)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/install-submitters.html

Displays a list of all available command-line options for the Deadline submitter installer on macOS. This command is crucial for understanding and utilizing advanced installation parameters. It requires navigating to the correct directory within the installer package.

```bash
/Maya-submitter-osx-installer.app/Contents/MacOS/installbuilder.sh --help

```

--------------------------------

### Display Help for Repository Installer (macOS)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/install-db-repo.html

Displays a list of all available command-line options for the Deadline Repository installer on macOS. This is crucial for understanding and utilizing various installation parameters. The script is located within the application bundle.

```bash
/DeadlineRepository-X.X.X.X-osx-installer.app/Contents/MacOS/installbuilder.sh --help
```

--------------------------------

### Cloud License Server URL Example

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/licensing-usage-based-proxy.html

This example shows the original URL for the Cloud License Server.

```text
https://thinkboxuat.compliance.flexnetoperations.com/instances/A1B2C3D4E5F6/request
```

--------------------------------

### NetworkRoot Setting Examples

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/client-config.html

Shows examples of the NetworkRoot setting in deadline.ini, which specifies the repository path for 'Direct' or 'Repository' connections. It also includes examples of additional NetworkRoot# settings for storing previous repository paths.

```ini
NetworkRoot=\\repository\path

```

```ini
NetworkRoot0=\\repository\path
NetworkRoot1=\\another\repository
NetworkRoot2=\\test\repository

```

--------------------------------

### Install 3ds Max Startup Script

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/app-vray-dbr.html

Copies the SMTDSetup.ms script to the 3ds Max scripts Startup directory. This script is essential for initializing Deadline's integration within 3ds Max.

```bash
cp [Repository]/submission/3dsmax/Client/SMTDSetup.ms [3ds Max Install Directory]/scripts/Startup/SMTDSetup.ms
```

--------------------------------

### Install Dependencies on Ubuntu (APT)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/system-requirements.html

This snippet shows how to install necessary libraries for Deadline Client Applications on Ubuntu systems using the APT package manager. It includes commands for both workstations and render nodes, covering lsb, X11, Xext, and OpenGL libraries.

```bash
sudo -s

# WORKSTATIONS
apt-get install lsb libx11-6 libxext-6 libgl1-mesa-6

# RENDERNODES
apt-get install lsb
```

--------------------------------

### Start Web Service with Launcher

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/launcher.html

Launches the Deadline Web Service by instructing an existing Launcher. This command will also initiate an automatic upgrade if one is detected.

```bash
deadlinelauncher -webservice

```

--------------------------------

### Unattended Secrets Management Installation (Windows)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/secrets-management/deadline-secrets-management.html

Provides an example command for installing the Secrets Management feature in unattended mode on Windows. This command requires parameters such as database connection details, SSL configuration, and credentials for the secrets admin. It also includes options for removing legacy secrets or existing installations.

```powershell
DeadlineRepository-windows-installer.exe --mode unattended --installmongodb false --secretsAdminName *** --secretsAdminPassword **** --dbssl true --dbhost "db-ip-address" --dbport 27100 --dbclientcert "C:\certs\cert_path.pfx" --dbname "deadline10db" --dbauth "true" --installSecretsManagement "true"

```

--------------------------------

### Run Deadline Connection Server with Parameters

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/remote-connection-server.html

Demonstrates the basic syntax for running the Deadline Connection Server with command-line parameters. Parameters are specified with '--<param name> <param value>'.

```bash
deadlinercs --<param name> <param value>
```

--------------------------------

### Start Deadline Monitor with Launcher

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/launcher.html

Starts the Deadline Monitor by instructing an existing Launcher process to do so. If an upgrade is available, this action will also trigger an automatic upgrade.

```bash
deadlinelauncher -monitor

```

--------------------------------

### Start Remote Connection Server (Linux)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/aws-portal-updating-deadline-when-using-aws-portal.html

This command starts the Deadline Remote Connection Server on a Linux machine. It assumes the DEADLINE_PATH environment variable is set to the Deadline installation directory.

```bash
"${DEADLINE_PATH}/deadlinercs"
```

--------------------------------

### Start Remote Connection Server (Windows)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/aws-portal-updating-deadline-when-using-aws-portal.html

This command starts the Deadline Remote Connection Server on a Windows machine. It assumes the DEADLINE_PATH environment variable is set to the Deadline installation directory.

```batch
"%DEADLINE_PATH%\deadlinercs.exe"
```

--------------------------------

### Python SCM Event Plugin Example for Deadline

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/event-plugins.html

This Python script demonstrates how to create a custom event listener plugin for Deadline to integrate with Software Configuration Management (SCM) systems. It defines callbacks for when a worker starts and when it starts a job, allowing for software updates or environment checks. This requires the Deadline API and its scripting utilities.

```python
from Deadline.Events import DeadlineEventListener
from Deadline.Scripting import ClientUtils

def GetDeadlineEventListener():
    """This is the function that Deadline calls to get an instance of the
    main DeadlineEventListener class.
    """
    return SoftwareEvent()

def CleanupDeadlineEventListener(deadlinePlugin):
    """This is the function that Deadline calls when the event plugin is
    no longer in use so that it can get cleaned up.
    """
    deadlinePlugin.Cleanup()

class SoftwareEvent(DeadlineEventListener):
    """This is the main DeadlineEventListener class for SoftwareEvent."""
    def __init__(self):
        # Set up the event callbacks here
        super().__init__() # Required in Deadline 10.3 and later. 
        self.OnSlaveStartedCallback += self.OnSlaveStarted
        self.OnSlaveStartingJobCallback += self.OnSlaveStartingJob

    def Cleanup(self):
        del self.OnSlaveStartedCallback
        del self.OnSlaveStartingJobCallback

    # This is called when a Worker is started.
    def OnSlaveStarted(self, string):
        # If a Worker has just started on a rendernode,
        # this can typically be a reliable and safe time
        # to carry out config/software deployment.
        self.SoftwareUpdate()

    # This is called when a Worker starts a job.
    def OnSlaveStartingJob(self, string, job):
        # You could query the returned job object when a
        # Worker first starts a job. Correct version of
        # renderer installed?
        self.SoftwareUpdate()

    def SoftwareUpdate(self):
        ClientUtils.LogText("Preparing for Software Update")
        # TODO: Execute command here to query your in-house
        # software deployment tool (SCM) to see if any new
        # software/sys env variables are required to be updated.
        pass

```

--------------------------------

### Configure Deadline Monitor Settings via Command Line

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/monitor.html

This example demonstrates how to set various Monitor options directly from the command line when launching the application. These options control aspects like drag-and-drop functionality and job batch grouping.

```bash
deadlinemonitor -draganddropdep True -groupjobbatches False

```

--------------------------------

### Get Slave Statistics using DeadlineCommand

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/command-line-arguments-housekeeping.html

Displays a summary of worker (slave) statistics, including counts for machines that are Starting Jobs, Rendering, Idle, Stalled, Offline, and Disabled. This command focuses on machine-related metrics.

```bash
C:\>deadlinecommand -GetSlaveStatistics
    Machines Starting Jobs: 0
    Rendering Machines: 0
    Idle Machines: 0
    Stalled Machines: 1
    OfflineMachines: 0
    Disabled Machines: 0

C:\>
```

--------------------------------

### Get Farm Statistics using DeadlineCommand

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/command-line-arguments-housekeeping.html

Retrieves and displays a summary of the current farm status, including job counts (Queued, Rendering, Suspended, Pending, Completed, Failed) and machine status (Starting, Rendering, Idle, Stalled, Offline, Disabled).

```bash
C:\>deadlinecommand -GetFarmStatistics
    Queued Jobs= 2
    Rendering Jobs= 0
    Suspended Jobs= 122
    Pending Jobs= 13
    Completed Jobs= 202
    Failed Jobs= 4

    Machines Starting Jobs: 0
    Rendering Machines: 0
    Idle Machines: 0
    Stalled Machines: 1
    OfflineMachines: 0
    Disabled Machines: 0

C:\>
```

--------------------------------

### Run AWS Portal S3 Setup using deadlinecommand

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/command-line-arguments-cloud.html

Sets up S3 buckets and associated access policies, users, and roles for the AWS Portal Asset Server. This command requires a single argument: the AWS Region where the setup should be performed.

```bash
deadlinecommand -RunAWSPortalS3Setup <Region>
```

--------------------------------

### Python Scheduled Event Plugin Example

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/event-plugins.html

This Python script demonstrates how to create a Deadline event plugin that runs on a scheduled interval, typically triggered by the 'House Cleaning' event. It includes functions for getting and cleaning up the event listener, and a placeholder for custom pipeline duties.

```python
from Deadline.Events import DeadlineEventListener

def GetDeadlineEventListener():
    """This is the function that Deadline calls to get an instance of the
    main DeadlineEventListener class.
    """
    return ScheduledEvent()

def CleanupDeadlineEventListener(deadlinePlugin):
    """This is the function that Deadline calls when the event plugin is
    no longer in use so that it can get cleaned up.
    """
    deadlinePlugin.Cleanup()

class ScheduledEvent (DeadlineEventListener):
    """This is the main DeadlineEventListener class for ScheduledEvent."""
    def __init__(self):
        # Set up the event callbacks here
        super().__init__() # Required in Deadline 10.3 and later.
        self.OnHouseCleaningCallback += self.OnHouseCleaning

    def Cleanup(self):
        del self.OnHouseCleaningCallback

    def OnHouseCleaning(self):
        # TODO: Execute generic pipeline duties here such as
        # reporting to an external studio database or injecting
        # Deadline Farm Stats into Zabbix, Zenoss, Nagios for IT
        pass

```

--------------------------------

### Lightwave Job Info File Example

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/manual-submission.html

An example Job Info file for a Lightwave job, detailing plugin, frame ranges, chunk size, priority, pool, group, name, output filename, and deletion settings. Shows specific configurations for Lightwave rendering.

```text
Plugin=Lightwave
Frames=1-10,21-30
ChunkSize=10
Priority=99
Pool=LightwavePool
Group=NiceShot
Name=Lightwave Test
OutputFilename0=\\fileserver\Renders\OutputFolder\test####.tif
DeleteOnComplete=true
MachineLimit=5
SlaveTimeout=3600
```

--------------------------------

### Get Directory with DeadlineCommand

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/command-line-arguments-system.html

Opens a folder browser dialog, allowing the user to select a directory. It can optionally start at a specified initial path. The selected path is printed to the console, or nothing is printed if the dialog is canceled.

```bash
deadlinecommand -GetDirectory
deadlinecommand -GetDirectory "C:\Program Files\Thinkbox\Deadline10\bin"
```

--------------------------------

### Resolve Maya Mental Ray License Errors

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/app-maya.html

This explains the 'could not get a license' error reported by Mental Ray during Maya rendering. It clarifies that Mental Ray requires an additional license for network rendering, unlike mayaSoftware and mayaHardware, and suggests contacting Maya support for setup assistance.

```text
Exception during render: Error: (Mayatomr) : could not get a license
Mental Ray is reporting that it can’t find a license. Mental Ray requires an additional license for network rendering, whereas renders such as mayaSoftware and mayaHardware simply uses your Maya license.
```

--------------------------------

### Multi-Region Configuration Example (JSON)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/event-spot-multi-region.html

This JSON configuration demonstrates how to set up multi-region fleet management in Deadline. It specifies regions, group configurations with IAM roles, allocation strategies, target capacities, and launch template details including instance types and weighted capacities. Ensure the 'DeadlineTrackedAWSResource : SpotEventPlugin' tag is applied to your Launch Templates.

```json
[
    {
        "region": "us-west-2",
        "group_configs": {
            "group_name_1": {
                "IamFleetRole": "arn:aws:iam::357432474442:role/aws-ec2-spot-fleet-tagging-role",
                "AllocationStrategy": "capacityOptimized",
                "TargetCapacity": 0,
                "ValidFrom": "2023-02-08T22:48:24.000Z",
                "ValidUntil": "2024-02-08T22:48:24.000Z",
                "TerminateInstancesWithExpiration": true,
                "Type": "maintain",
                "OnDemandAllocationStrategy": "lowestPrice",
                "LaunchSpecifications": [],
                "LaunchTemplateConfigs": [
                    {
                        "LaunchTemplateSpecification": {
                            "LaunchTemplateId": "lt-0d4626a3",
                            "Version": "$Latest"
                        },
                        "Overrides": [
                            {
                                "InstanceType": "m5.4xlarge",
                                "WeightedCapacity": 1
                            },
                            {
                                "InstanceType": "c5.4xlarge",
                                "WeightedCapacity": 1
                            },
                            {
                                "InstanceType": "r5.4xlarge",
                                "WeightedCapacity": 1
                            }
                        ]
                    }
                ]
            },
            "group_name_2": {
                "IamFleetRole": "arn:aws:iam::357432474442:role/aws-ec2-spot-fleet-tagging-role",
                "AllocationStrategy": "capacityOptimized",
                "TargetCapacity": 0,
                "ValidFrom": "2023-02-08T22:48:24.000Z",
                "ValidUntil": "2024-02-08T22:48:24.000Z",
                "TerminateInstancesWithExpiration": true,
                "Type": "maintain",
                "OnDemandAllocationStrategy": "lowestPrice",
                "LaunchSpecifications": [],
                "LaunchTemplateConfigs": [
                    {
                        "LaunchTemplateSpecification": {
                            "LaunchTemplateId": "lt-0d4626a3",
                            "Version": "$Latest"
                        },
                        "Overrides": [
                            {
                                "InstanceType": "m5.4xlarge",
                                "WeightedCapacity": 1
                            },
                            {
                                "InstanceType": "c5.4xlarge",
                                "WeightedCapacity": 1
                            },
                            {
                                "InstanceType": "r5.4xlarge",
                                "WeightedCapacity": 1
                            }
                        ]
                    }
                ]
            }
        }
    },
    {
        "region": "us-east-1",
        "group_configs": {
            "group_name_3": {
                "IamFleetRole": "arn:aws:iam::357432474442:role/aws-ec2-spot-fleet-tagging-role",
                "AllocationStrategy": "capacityOptimized",
                "TargetCapacity": 0,
                "ValidFrom": "2023-02-08T22:47:02.000Z",
                "ValidUntil": "2024-02-08T22:47:02.000Z",
                "TerminateInstancesWithExpiration": true,
                "Type": "maintain",
                "OnDemandAllocationStrategy": "lowestPrice",
                "LaunchSpecifications": [],
                "LaunchTemplateConfigs": [
                    {
                        "LaunchTemplateSpecification": {
                            "LaunchTemplateId": "lt-074b5b3d",
                            "Version": "$Latest"
                        },
                        "Overrides": [
                            {
                                "InstanceType": "m5.4xlarge",
                                "WeightedCapacity": 1
                            },
                            {
                                "InstanceType": "c5.4xlarge",
                                "WeightedCapacity": 1
                            },
                            {

```

--------------------------------

### Secrets Management Installation

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/1_User%20Manual/manual/secrets-management/deadline-secrets-management.html

Instructions for installing the Secrets Management feature, including manual and unattended installation methods.

```APIDOC
## Secrets Management Installation

### Description
This section details how to install the Deadline Secrets Management feature, which provides a secure way to store sensitive information like passwords and API keys.

### Method
N/A (Installation Process)

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Installation Steps:
1. **Enable TLS/SSL Database Communication**: This is a prerequisite for enabling the Secrets Management feature.
2. **Run Repository Installer**: Select the option to install the Deadline Secrets Management feature and create an initial admin user.
3. **Record Admin Password**: Securely store the administrator password, as it cannot be recovered if lost.

### Unattended Mode Installation:
To install Secrets Management in unattended mode, provide the following parameters to the Repository Installer:
- `--installSecretsManagement true`
- `--secretsAdminName <admin_username>`
- `--secretsAdminPassword <admin_password>`

**Optional Parameters:**
- `--removeLegacySecrets true`: To remove legacy secrets.
- `--removeSecretsManagement true`: To remove an existing Secrets Management installation.

### Example (Windows, unattended):
```bash
DeadlineRepository-windows-installer.exe --mode unattended --installmongodb false --secretsAdminName *** --secretsAdminPassword **** --dbssl true --dbhost "db-ip-address" --dbport 27100 --dbclientcert "C:\certs\cert_path.pfx" --dbname "deadline10db" --dbauth "true" --installSecretsManagement "true"
```

### Upgrade Existing Install Without Secrets Management:
While not recommended, you can upgrade an existing installation without Secrets Management:
1. Update your Repository using the Repository Installer documentation.
2. When prompted, select the option to "Skip the Secrets Management installation" and continue.

### Response
N/A (Installation Process)

### Response Example
N/A
```
Tokens:
Raw