Deadline Scripting Reference

https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/
Admin
Deadline Scripting Reference provides Python scripting APIs and documentation for customizing...
Tokens:339,174
Snippets:3,524
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Start Instance

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/functions_func_s.html

Starts a cloud instance.

```APIDOC
## StartInstance()

### Description
Starts a cloud instance.

### Method
Not applicable (SDK function)

### Endpoint
Not applicable (SDK function)

### Parameters
None explicitly documented.

### Response
Returns a Deadline.Scripting.CloudUtils object.
```

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

### StartInstancesCallback

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_cloud_1_1_cloud_plugin_wrapper.html

Callback to start the given instances and return a list of boolean values indicating which instances started successfully.

```APIDOC
## StartInstancesCallback

### Description
Start the given instances and return list of boolean values indicating which instances started successfully.

### Signature
`GenericDelegate1<bool[], string[]> StartInstancesCallback`

### Parameters
#### Path Parameters
- **instanceIds** (string[]) - Required - A list of instance IDs to start.
```

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

### CreateInstancesCallback

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_cloud_1_1_cloud_plugin_wrapper.html

Callback to start the given instances and return a list of CloudInstance objects that have been started.

```APIDOC
## CreateInstancesCallback

### Description
Start the given instances and return list of CloudInstance objects that have been started.

### Signature
`GenericDelegate3<CloudInstance[], string, string, int> CreateInstancesCallback`

### Parameters
#### Path Parameters
- **poolName** (string) - Required - The name of the pool to create instances from.
- **machineNames** (string[]) - Required - A list of machine names to start.
- **poolSize** (int) - Required - The number of instances to start.
```

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

### JobFridayStartTime

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_jobs_1_1_job.html

Gets or sets Friday's start time.

```APIDOC
## ◆ JobFridayStartTime
| TimeSpan Deadline.Jobs.Job.JobFridayStartTime
---
getset
Gets or sets Friday's start time.
```

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

### TaskRenderStartTime

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_jobs_1_1_task.html

Gets the date and time when the Task started rendering.

```APIDOC
## ◆ TaskRenderStartTime
| DateTime Deadline.Jobs.Task.TaskRenderStartTime
---
get
The date/time the Task started rendering.
```

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

### JobMondayStartTime

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_jobs_1_1_job.html

Gets or sets Monday's start time for job scheduling.

```APIDOC
## ◆ JobMondayStartTime
| TimeSpan Deadline.Jobs.Job.JobMondayStartTime
---
getset
Gets or sets Monday's start time.
```

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

### StartOffset Property

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_jobs_1_1_offset_dependency.html

Gets or sets the start offset for the dependency.

```APIDOC
## StartOffset Property

### Description
The start offset for the dependency.

### Type
int

### Access
getset
```

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

### Start Monitored Program

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/functions_func_s.html

Starts a monitored program.

```APIDOC
## StartMonitoredProgram()

### Description
Starts a monitored program.

### Method
Not applicable (SDK function)

### Endpoint
Not applicable (SDK function)

### Parameters
None explicitly documented.

### Response
Returns a Deadline.Plugins.DeadlinePlugin object.
```

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

### StartTime

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_power_mgmt_1_1_idle_shutdown_override.html

Gets or sets the start time for this override. This time is TimeZone-agnostic.

```APIDOC
## StartTime

### Description
The start time for this override. This should be TimeZone-agnostic.

### Property Type
DateTime

### Access
Read-write
```

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

### Start Monitored Program As User

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_plugins_1_1_deadline_plugin.html

Starts a program as a specified user for monitoring, with automatic stopping upon task completion.

```APIDOC
## StartMonitoredProgramAsUser

### Description
Runs a monitored process as the given user. The process is monitored while it is running to determine if it exits unexpectedly, and it will be stopped automatically when the task is finished.

### Method
N/A (Function Call)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Parameters
* **name** (string) - The name to assign to the monitored program.
* **executable** (string) - The path to the executable file.
* **arguments** (string) - The command-line arguments for the executable.
* **startupDirectory** (string) - The working directory for the process.
* **userName** (string) - The username to run the process as.
* **domain** (string) - The domain for the username.
* **password** (string) - The password for the username.
* **useSu** (bool) - Whether to use 'su' command (Linux/macOS).
* **preserveEnvironment** (bool) - Whether to preserve the current environment variables.
* **setHomeVariable** (bool) - Whether to set the HOME environment variable.
```

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

### Settings

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_balancer_1_1_balancer_info_settings.html

Gets the BalancerSettings object.

```APIDOC
## Settings

### Description
Retrieves the BalancerSettings object associated with this BalancerInfoSettings.

### Method
GET (Implicit - Property Access)

### Endpoint
N/A (This is a property of the BalancerInfoSettings class)

### Parameters
None

### Response
#### Success Response (BalancerSettings)
- **Settings** (BalancerSettings) - The BalancerSettings object.
```

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

### Start Monitored Managed Process

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_plugins_1_1_deadline_plugin.html

Starts a ManagedProcess object for manual management, returning immediately after process initiation.

```APIDOC
## StartMonitoredManagedProcess

### Description
Runs the given ManagedProcess object. The managing of this process must be handled manually. This function will return as soon as the process has started.

### Method
N/A (Function Call)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Parameters
* **name** (string) - The name to assign to the monitored managed process.
* **managedProcess** (ManagedProcess) - The ManagedProcess object to start.
```

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

### Start Monitored Managed Process As User

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_plugins_1_1_deadline_plugin.html

Starts a ManagedProcess object as a specified user for manual management, returning immediately.

```APIDOC
## StartMonitoredManagedProcessAsUser

### Description
Runs the given ManagedProcess object as the given user. The managing of this process must be handled manually. This function will return as soon as the process has started.

### Method
N/A (Function Call)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Parameters
* **name** (string) - The name to assign to the monitored managed process.
* **managedProcess** (ManagedProcess) - The ManagedProcess object to start.
* **userName** (string) - The username to run the process as.
* **domain** (string) - The domain for the username.
* **password** (string) - The password for the username.
* **useSu** (bool) - Whether to use 'su' command (Linux/macOS).
* **preserveEnvironment** (bool) - Whether to preserve the current environment variables.
* **setHomeVariable** (bool) - Whether to set the HOME environment variable.
```

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

### Deadline.Cloud.GroupMapping.Pools

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_cloud_1_1_group_mapping.html

Pools to start the instances in.

```APIDOC
## ◆ Pools
| string [] Deadline.Cloud.GroupMapping.Pools
---
getset
Pools to start the instances in.
```

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

### Start Monitored Program

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_plugins_1_1_deadline_plugin.html

Starts a program to be monitored for unexpected exits, with automatic stopping upon task completion.

```APIDOC
## StartMonitoredProgram

### Description
Runs a monitored process. The process is monitored while it is running to determine if it exits unexpectedly, and it will be stopped automatically when the task is finished.

### Method
N/A (Function Call)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Parameters
* **name** (string) - The name to assign to the monitored program.
* **executable** (string) - The path to the executable file.
* **arguments** (string) - The command-line arguments for the executable.
* **startupDirectory** (string) - The working directory for the process.
```

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

### JobSaturdayStartTime

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_jobs_1_1_job.html

Gets or sets the start time for Saturday.

```APIDOC
## ◆ JobSaturdayStartTime
| TimeSpan Deadline.Jobs.Job.JobSaturdayStartTime
---
getset
Gets or sets Saturday's start time.
```

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

### JobSundayStartTime

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_jobs_1_1_job.html

Gets or sets Sunday's start time.

```APIDOC
## ◆ JobSundayStartTime
| TimeSpan Deadline.Jobs.Job.JobSundayStartTime
---
getset
Gets or sets Sunday's start time.
```

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

### GetRootDirectory

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/functions_func_g.html

Retrieves the root directory of the Deadline installation.

```APIDOC
## GetRootDirectory()

### Description
Retrieves the file system path to the root directory of the Deadline installation on the current machine.

### Method
Not applicable (Scripting Function)

### Endpoint
Not applicable (Scripting Function)

### Parameters
None

### Response
Returns a Deadline.Scripting.RepositoryUtils object representing the Deadline root directory.
```

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

### JobStartedDateTime

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_jobs_1_1_job.html

Gets the date and time at which the job started rendering.

```APIDOC
## ◆ JobStartedDateTime
| DateTime Deadline.Jobs.Job.JobStartedDateTime
---
get
The date/time at which the job started rendering.
```

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

### StartInstance

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_scripting_1_1_cloud_utils-members.html

Starts a specified cloud instance in a given region. This is used to bring a stopped instance back online.

```APIDOC
## StartInstance

### Description
Starts a specified cloud instance in a given region. This is used to bring a stopped instance back online.

### Method
static

### Endpoint
N/A (Scripting Method)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response
N/A

#### Response Example
N/A
```

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

### MachineStartupOptions

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_power_mgmt_1_1_power_management_group.html

Gets or sets the machine startup options for this group.

```APIDOC
## ◆ MachineStartupOptions
| MachineStartupOptions Deadline.PowerMgmt.PowerManagementGroup.MachineStartupOptions
---
getset
The machine startup options for this group.
```

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

### CreateNewConsole

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_frantic_x_1_1_processes_1_1_managed_process.html

Gets or sets if a new console should be created.

```APIDOC
## Property: CreateNewConsole

### Description
Gets or sets if a new console should be created.

### Type
bool

### Access
getset
```

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

### StartupDirectoryCallback

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_frantic_x_1_1_processes_1_1_managed_process.html

Assign a function to this callback to specify the directory from which the executable should run.

```APIDOC
## ◆ StartupDirectoryCallback

### Description
If a function is assigned to this callback, it will be called to return the directory that the exectuable should run.

### Callback Signature
`GenericDelegate0<string>`
```

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

### JobFrameDependencyOffsetStart

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_jobs_1_1_job.html

Gets or sets the start offset for frame dependencies.

```APIDOC
## ◆ JobFrameDependencyOffsetStart
| int Deadline.Jobs.Job.JobFrameDependencyOffsetStart
---
getset
The start offset for frame depenencies.
```

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

### GetSlaveSettingsList (bool)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_scripting_1_1_repository_utils.html

Gets all the Worker settings.

```APIDOC
## GetSlaveSettingsList

### Description
Gets all the Worker settings.

### Method
static SlaveSettings[]

### Parameters
#### Path Parameters
- **invalidateCache** (bool) - Description not available
```

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

### OnMachineStartup

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/functions_func_o.html

Callback function for when a machine starts up. Part of the Deadline.Events.DeadlineEventListener class.

```APIDOC
## OnMachineStartup()

### Description
This event listener is triggered when a machine in the Deadline farm starts up. It is part of the Deadline.Events.DeadlineEventListener class.

### Method
Event Handler

### Endpoint
N/A (Event listener method)

### Parameters
None explicitly documented in this context.
```

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

### Machine Startup Options Properties

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_power_mgmt_1_1_machine_startup_options.html

Provides access to various properties for configuring machine startup and Wake-on-LAN behavior.

```APIDOC
## Properties

---

string | Command `[get, set]`
| The command to run if WakeOnLan is disabled. More...

bool | DebugMode `[get, set]`
| If machine startup is running in debug mode. More...

bool | DisabledByThermalShutdown `[get, set]`
| If the group was disabled by thermal shutdown. More...

bool | Enabled `[get, set]`
| If machine startup is enabled. More...

int | MillisecondsBetweenWOLPackects `[get, set]`
| The number of milliseconds between each machine Wake On LAN Packet. More...

string[] | OrderOverrideArray `[get, set]`
| A Worker array used to set the order of startup. More...

bool | OverrideOrder `[get, set]`
| Whether or not to use the order override array or not. More...

bool | SendStartSlaveCommand `[get, set]`
| If the "Start Worker" remote command should be sent in addition to waking up the machine. More...

int | SlavesToWakeupPerInterval `[get, set]`
| The number of machines to wake up per interval. More...

int | TargetExtraIdleSlaves `[get, set]`
| The target number of extra idle Workers available. More...

bool | WakeOnLan `[get, set]`
| If the group uses Wake On LAN. More...

## Detailed Description
The options for wake on LAN.

## Property Documentation
## ◆ Command
| string Deadline.PowerMgmt.MachineStartupOptions.Command
---
getset
The command to run if WakeOnLan is disabled.

## ◆ DebugMode
| bool Deadline.PowerMgmt.MachineStartupOptions.DebugMode
---
getset
If machine startup is running in debug mode.
```

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

### JobWednesdayStartTime

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_jobs_1_1_job.html

Gets or sets Wednesday's start time for a job.

```APIDOC
## ◆ JobWednesdayStartTime
| TimeSpan Deadline.Jobs.Job.JobWednesdayStartTime
---
getset
Gets or sets Wednesday's start time.
```

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

### JobTuesdayStartTime

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_jobs_1_1_job.html

Gets or sets Tuesday's start time for a job.

```APIDOC
## ◆ JobTuesdayStartTime
| TimeSpan Deadline.Jobs.Job.JobTuesdayStartTime
---
getset
Gets or sets Tuesday's start time.
```

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

### OnMachineStartup

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_events_1_1_deadline_event_listener.html

Calls the on machine startup callback. This method is triggered when a group of machines is set to start up.

```APIDOC
## OnMachineStartup

### Description
Calls the on machine startup callback.

### Method
virtual void

### Parameters
* **groupName** (string) - The name of the group of machines.
* **slaveNames** (string[]) - An array of slave names.
* **machineStartupOptions** (MachineStartupOptions) - Options for machine startup.

### Response
None
```

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

### Deadline.PowerMgmt.MachineStartupOptions Properties

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_power_mgmt_1_1_machine_startup_options.html

Provides access to various settings that control how machines start up, including Wake-On-LAN configurations, startup order, and thermal shutdown behavior.

```APIDOC
## Class: Deadline.PowerMgmt.MachineStartupOptions

### Description
This class provides properties to configure machine startup behavior for Deadline's power management.

### Properties

- **DisabledByThermalShutdown** (bool) - getset - If the group was disabled by thermal shutdown.
- **Enabled** (bool) - getset - If machine startup is enabled.
- **MillisecondsBetweenWOLPackects** (int) - getset - The number of milliseconds between each machine Wake On LAN Packet.
- **OrderOverrideArray** (string []) - getset - A Worker array used to set the order of startup.
- **OverrideOrder** (bool) - getset - Whether or not to use the order override array or not.
- **SendStartSlaveCommand** (bool) - getset - If the "Start Worker" remote command should be sent in addition to waking up the machine.
- **SlavesToWakeupPerInterval** (int) - getset - The number of machines to wake up per interval.
- **TargetExtraIdleSlaves** (int) - getset - The target number of extra idle Workers available.
- **WakeOnLan** (bool) - getset - If the group uses Wake On LAN.
```

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

### JobScheduledStartDateTime

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_jobs_1_1_job.html

Gets or sets the date and time at which a scheduled job should start.

```APIDOC
## ◆ JobScheduledStartDateTime
| DateTime Deadline.Jobs.Job.JobScheduledStartDateTime
---
getset
The start date/time at which the scheduled job should start.
```

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

### SpawnProcess (full overload)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_scripting_1_1_process_utils.html

Spawns a new process with the specified executable, arguments, working directory, and window style. This provides the most control over how the process is launched.

```APIDOC
## SpawnProcess(executable, arguments, workingDirectory, windowStyle)

### Description
Spawns a new process by executing the specified executable file with the provided arguments, setting a specific working directory, and defining the window style. This overload offers comprehensive control over the process execution.

### Method
static

### Parameters
#### Path Parameters
- **executable** (string) - Required - The executable file name to spawn.
- **arguments** (string) - Required - The command-line arguments to pass to the executable.
- **workingDirectory** (string) - Required - The working directory for the spawned process.
- **windowStyle** (ProcessWindowStyle) - Required - The window style for the spawned process (e.g., Normal, Hidden, Minimized).

### Returns
- **Process** - The process object representing the spawned process.
```

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

### JobPreTaskScript

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_jobs_1_1_job.html

Gets and sets the script to execute before a job task starts.

```APIDOC
## ◆ JobPreTaskScript

### Description
Gets and sets the script to execute before a job task starts.

### Method
GET, PUT

### Endpoint
`/jobs/{jobId}/preTaskScript`

### Parameters
#### Path Parameters
- **jobId** (string) - Required - The ID of the job.

#### Request Body (for PUT)
- **preTaskScript** (string) - Required - The path to the pre-task script.

### Response
#### Success Response (200)
- **preTaskScript** (string) - The path to the pre-task script.
```

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

### SpawnProcess (executable, arguments, workingDirectory, windowStyle)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_scripting_1_1_process_utils.html

Spawns a new process from the specified executable with the given arguments, working directory, and window style.

```APIDOC
## SpawnProcess (executable, arguments, workingDirectory, windowStyle)

### Description
Spawns a process from the specified executable with the given arguments, working directory, and window style.

### Method
static Process

### Parameters
#### Path Parameters
- **executable** (string) - Required - The path to the executable file.
- **arguments** (string) - Required - The command-line arguments to pass to the executable.
- **workingDirectory** (string) - Required - The working directory for the new process.
- **windowStyle** (ProcessWindowStyle) - Required - The style of the process window.
```

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

### SpawnProcess (executable, arguments, workingDirectory, windowStyle, redirectStdOutput)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_scripting_1_1_process_utils.html

Spawns a new process from the specified executable with the given arguments, working directory, window style, and standard output redirection.

```APIDOC
## SpawnProcess (executable, arguments, workingDirectory, windowStyle, redirectStdOutput)

### Description
Spawns a process from the specified executable with the given arguments, working directory, window style, and standard output redirection.

### Method
static Process

### Parameters
#### Path Parameters
- **executable** (string) - Required - The path to the executable file.
- **arguments** (string) - Required - The command-line arguments to pass to the executable.
- **workingDirectory** (string) - Required - The working directory for the new process.
- **windowStyle** (ProcessWindowStyle) - Required - The style of the process window.
- **redirectStdOutput** (bool) - Required - Whether to redirect the standard output of the process.
```

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

### SpawnProcess

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_scripting_1_1_process_utils-members.html

Spawns a new process with specified arguments, working directory, and window style.

```APIDOC
## SpawnProcess (executable, arguments, workingDirectory, windowStyle)

### Description
Spawns a new process with specified arguments, working directory, and window style.

### Method
static

### Parameters
#### Path Parameters
- **executable** (string) - Description: The path to the executable file.
- **arguments** (string) - Description: The arguments to pass to the executable.
- **workingDirectory** (string) - Description: The working directory for the new process.
- **windowStyle** (ProcessWindowStyle) - Description: The style of the process window.

### Response
#### Success Response (Process)
- Returns a Process object representing the spawned process.
```

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

### JobThursdayStartTime

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_jobs_1_1_job.html

Gets or sets Thursday's start time. This property is both gettable and settable.

```APIDOC
## ◆ JobThursdayStartTime
| TimeSpan Deadline.Jobs.Job.JobThursdayStartTime
---
getset
Gets or sets Thursday's start time.
```

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

### ReEnableStartupTemp

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_power_mgmt_1_1_thermal_shutdown_options.html

Specifies the temperature at which Machine Startup should be re-enabled. This is a get/set property.

```APIDOC
## ◆ ReEnableStartupTemp
| Temperature Deadline.PowerMgmt.ThermalShutdownOptions.ReEnableStartupTemp  
---
getset
The Re-enable startup temperature.
```

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

### JobStartJobTimeoutSeconds

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_jobs_1_1_job.html

Gets or sets the timespan a job's task has to start before a timeout occurs.

```APIDOC
## ◆ JobStartJobTimeoutSeconds
| int Deadline.Jobs.Job.JobStartJobTimeoutSeconds
---
getset
The timespan a job's task has to start before a timeout occurs.
```

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

### GetIniFileSetting()

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/functions_g.html

Retrieves a specific setting from an INI file. This function from Deadline.Scripting.FileUtils allows direct access to configuration values.

```APIDOC
## GetIniFileSetting()

### Description
Retrieves a specific setting from an INI file. This function from Deadline.Scripting.FileUtils allows direct access to configuration values.

### Method
Not Applicable (Static Method)

### Endpoint
Not Applicable

### Parameters
None

### Response
#### Success Response
- **Deadline.Scripting.FileUtils**: The FileUtils object, which may contain the setting or provide access to it.
```

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

### JobInitializePluginTimeoutSeconds

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_jobs_1_1_job.html

Gets or sets the timespan a job's task has to start before a timeout occurs.

```APIDOC
## ◆ JobInitializePluginTimeoutSeconds
| int Deadline.Jobs.Job.JobInitializePluginTimeoutSeconds
---
getset
The timespan a job's task has to start before a timeout occurs.
```

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

### StartTime

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_power_mgmt_1_1_idle_shutdown_override.html

Gets or sets the start time for this idle shutdown override. This time should be TimeZone-agnostic.

```APIDOC
## ◆ StartTime
| DateTime Deadline.PowerMgmt.IdleShutdownOverride.StartTime
---
getset
The start time for this override. This should be TimeZone-agnostic.
```

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

### SpawnProcess

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_scripting_1_1_process_utils-members.html

Spawns a new process with specified arguments, working directory, window style, and standard output redirection.

```APIDOC
## SpawnProcess (executable, arguments, workingDirectory, windowStyle, redirectStdOutput)

### Description
Spawns a new process with specified arguments, working directory, window style, and standard output redirection.

### Method
static

### Parameters
#### Path Parameters
- **executable** (string) - Description: The path to the executable file.
- **arguments** (string) - Description: The arguments to pass to the executable.
- **workingDirectory** (string) - Description: The working directory for the new process.
- **windowStyle** (ProcessWindowStyle) - Description: The style of the process window.
- **redirectStdOutput** (bool) - Description: Whether to redirect the standard output of the process.

### Response
#### Success Response (Process)
- Returns a Process object representing the spawned process.
```

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

### SpawnProcess (executable, arguments, workingDirectory)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_scripting_1_1_process_utils.html

Spawns a new process from the specified executable with the given arguments and working directory.

```APIDOC
## SpawnProcess (executable, arguments, workingDirectory)

### Description
Spawns a process from the specified executable with the given arguments and working directory.

### Method
static Process

### Parameters
#### Path Parameters
- **executable** (string) - Required - The path to the executable file.
- **arguments** (string) - Required - The command-line arguments to pass to the executable.
- **workingDirectory** (string) - Required - The working directory for the new process.
```

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

### JobMaintenanceJobStartFrame

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_jobs_1_1_job.html

Gets the start frame for a maintenance job. This property defines the frame range for maintenance-related tasks.

```APIDOC
## ◆ JobMaintenanceJobStartFrame
| int Deadline.Jobs.Job.JobMaintenanceJobStartFrame
---
get
The start frame for a maintenance job.
```

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

### Events - g

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/functions_evnt.html

Lists events starting with the letter 'g'. These include callbacks for getting active instances, hostnames, and image sources.

```APIDOC
## Events - g

### GetActiveInstancesCallback : Deadline.Cloud.CloudPluginWrapper

*   **Description**: Callback for retrieving active cloud instances.

### GetHostnameCallback : Deadline.Cloud.CloudPluginWrapper

*   **Description**: Callback for retrieving the hostname.

### GetImageSourcesCallback : Deadline.Cloud.CloudPluginWrapper

*   **Description**: Callback for retrieving image sources.
```

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

### SpawnProcess

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_scripting_1_1_process_utils-members.html

Spawns a new process with specified arguments and working directory.

```APIDOC
## SpawnProcess (executable, arguments, workingDirectory)

### Description
Spawns a new process with specified arguments and working directory.

### Method
static

### Parameters
#### Path Parameters
- **executable** (string) - Description: The path to the executable file.
- **arguments** (string) - Description: The arguments to pass to the executable.
- **workingDirectory** (string) - Description: The working directory for the new process.

### Response
#### Success Response (Process)
- Returns a Process object representing the spawned process.
```

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

### SlaveIdleProcessNames

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_slaves_1_1_slave_settings.html

Gets the list of process names that prevent a Worker from starting when the machine is considered idle. This is a read-only property reflecting current configuration.

```APIDOC
## SlaveIdleProcessNames

### Description
The Worker will not start when the machine is idle if any processes in SlaveIdleProcessNames are currently running on the machine.

### Method
GET

### Endpoint
/api/slaves/{slaveId}/idleProcessNames

### Response
- **processNames** (string[]) - An array of strings representing the process names that indicate the machine is not idle.
```

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

### StartJobCallback

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_plugins_1_1_deadline_plugin.html

This callback is for Advanced plugins only and is called when the job is first started on the Worker.

```APIDOC
## StartJobCallback

### Description
This is for Advanced plugins only. If a function is assigned to this callback, it will be called when the job is first started on the Worker.

### Signature
`GenericDelegate0 Deadline.Plugins.DeadlinePlugin.StartJobCallback`
```

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

### ReEnableStartup

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_power_mgmt_1_1_thermal_shutdown_options.html

Controls whether Machine Startup should be re-enabled after a shutdown. This is a get/set property.

```APIDOC
## ◆ ReEnableStartup
| bool Deadline.PowerMgmt.ThermalShutdownOptions.ReEnableStartup  
---
getset
Whether or not to re-enable Machine Startup.
```

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

### GetFrameRangeFromFilename

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_scripting_1_1_frame_utils.html

Gets the frame range from a given file by figuring out the start and end frames in a sequence. This is a static method within the FrameUtils class.

```APIDOC
## GetFrameRangeFromFilename()

### Description
Gets the frame range from a given file by figuring out the start and end frames in a sequence.

### Method
static string

### Parameters
#### Path Parameters
- **_filename_** (string) - Required - The file name, which is part of a sequence.

### Returns
- **string** - The frame range formatted as [start]-[end].
```

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

### Spawn Process

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/functions_func_s.html

Spawns a new process.

```APIDOC
## SpawnProcess()

### Description
Spawns a new process.

### Method
Not applicable (SDK function)

### Endpoint
Not applicable (SDK function)

### Parameters
None explicitly documented.

### Response
Returns a Deadline.Scripting.ProcessUtils object.
```

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

### GetFrameRangeFromFilename

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_scripting_1_1_frame_utils.html

Gets the frame range from a given file by figuring out the start and end frames in a sequence. This is useful for determining the extent of a file sequence.

```APIDOC
## GetFrameRangeFromFilename

### Description
Gets the frame range from a given file by figuring out the start and end frames in a sequence.

### Method
static string

### Parameters
#### Path Parameters
- **filename** (string) - Description: The filename to determine the frame range from.

### Response
#### Success Response
- **string** (string) - The frame range string (e.g., "1-100").
```

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

### PressEnterDuringRender

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_frantic_x_1_1_processes_1_1_managed_process.html

Gets or sets if the Enter button should be pressed shortly after starting the process. This can be useful if the process requires a key press to exit after it finishes running.

```APIDOC
## ◆ PressEnterDuringRender
| bool FranticX.Processes.ManagedProcess.PressEnterDuringRender  
---
getset
Gets or sets if the Enter button should be pressed shortly after starting the process. This can be useful if the process requires a key press to exit after it finishes running.
```

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

### SpawnProcess

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_scripting_1_1_process_utils-members.html

Spawns a new process.

```APIDOC
## SpawnProcess (executable)

### Description
Spawns a new process.

### Method
static

### Parameters
#### Path Parameters
- **executable** (string) - Description: The path to the executable file.

### Response
#### Success Response (Process)
- Returns a Process object representing the spawned process.
```

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

### SlaveEnableIdleRamPercentThreshold

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_slaves_1_1_slave_settings.html

Gets or sets a boolean value. If enabled, the Worker will not start when the machine is idle unless the current RAM usage (as a percentage) is below the specified threshold.

```APIDOC
## ◆ SlaveEnableIdleRamPercentThreshold
| bool Deadline.Slaves.SlaveSettings.SlaveEnableIdleRamPercentThreshold
---
getset
If enabled, the Worker will not start when the machine is idle unless the current RAM usage of the machine is lower than the value (as a percentage) in SlaveEnableRamPercentThreshold.
```

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

### SpawnProcess

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_scripting_1_1_process_utils-members.html

Spawns a new process with specified arguments.

```APIDOC
## SpawnProcess (executable, arguments)

### Description
Spawns a new process with specified arguments.

### Method
static

### Parameters
#### Path Parameters
- **executable** (string) - Description: The path to the executable file.
- **arguments** (string) - Description: The arguments to pass to the executable.

### Response
#### Success Response (Process)
- Returns a Process object representing the spawned process.
```

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

### PathMappingRule() Constructor (7 parameters)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_frantic_x_1_1_i_o_1_1_path_mapping_rule.html

Creates a new PathMappingRule with specified path, OS-specific paths, case sensitivity, regular expression flag, prefix mapping option, and region.

```APIDOC
## PathMappingRule()

### Description
Creates a new PathMappingRule and initializes several of its properties.

### Parameters
- **path** (string) - The path which will be replaced by an OS-specific variant. Can be accessed/changed after construction via the Path property.
- **windowsPath** (string) - The Windows-specific path that is equivalent to _path_. Can be accessed/changed after construction via the WindowsPath property.
- **linuxPath** (string) - The Linux-specific path that is equivalent to _path_. Can be accessed/changed after construction via the LinuxPath property.
- **macPath** (string) - The Mac-specific path that is equivalent to _path_. Can be accessed/changed after construction via the MacPath property.
- **caseSenstive** (bool) - Whether or not a case-sensitive comparison should be used when matching against _path_. Can be accessed/changed after construction via the CaseSensitive property.
- **regularExpression** (bool) - If true, denotes that the value in _path_ is a Regular Expresion, and that RegEx matching should be used. Can be accessed/changed after construction via the RegularExpression property.
- **mapPrefixOnly** (bool) - Can be accessed/changed after construction via the MapPrefixOnly property.
- **region** (string) - The region in which this path mapping rule should be applicable. Can be accessed/changed after construction via the Region property.
```

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

### SlaveEnableIdleProcessCheck

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_slaves_1_1_slave_settings.html

Gets or sets a flag to enable checking for specific running processes when determining if a machine is idle. If enabled, the Worker will not start if any processes in SlaveIdleProcessNames are running.

```APIDOC
## SlaveEnableIdleProcessCheck

### Description
If enabled, the Worker will not start when the machine is idle if any processes in SlaveIdleProcessNames are currently running on the machine.

### Method
GET, PUT

### Endpoint
/api/slaves/{slaveId}/enableIdleProcessCheck

### Parameters
#### Request Body (for PUT)
- **enable** (boolean) - Required - True to enable idle process checking.

### Response (for GET)
- **enable** (boolean) - The current status of idle process checking.
```

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

### SlaveEnableIdleCpuThreshold

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_slaves_1_1_slave_settings.html

Gets or sets a flag to enable CPU usage threshold checking for idle status. If enabled, the Worker will only start if the machine's CPU usage is below SlaveIdleCpuThreshold.

```APIDOC
## SlaveEnableIdleCpuThreshold

### Description
If enabled, the Worker will not start when the machine is idle unless the current CPU usage of the machine is lower than the value in SlaveIdleCpuThreshold.

### Method
GET, PUT

### Endpoint
/api/slaves/{slaveId}/enableIdleCpuThreshold

### Parameters
#### Request Body (for PUT)
- **enable** (boolean) - Required - True to enable CPU idle threshold checking.

### Response (for GET)
- **enable** (boolean) - The current status of CPU idle threshold checking.
```

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

### PathMappingRule() Constructor (6 parameters)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_frantic_x_1_1_i_o_1_1_path_mapping_rule.html

Creates a new PathMappingRule with specified path, OS-specific paths, case sensitivity, regular expression flag, and prefix mapping option.

```APIDOC
## PathMappingRule()

### Description
Creates a new PathMappingRule and initializes several of its properties.

### Parameters
- **path** (string) - The path which will be replaced by an OS-specific variant. Can be accessed/changed after construction via the Path property.
- **windowsPath** (string) - The Windows-specific path that is equivalent to _path_. Can be accessed/changed after construction via the WindowsPath property.
- **linuxPath** (string) - The Linux-specific path that is equivalent to _path_. Can be accessed/changed after construction via the LinuxPath property.
- **macPath** (string) - The Mac-specific path that is equivalent to _path_. Can be accessed/changed after construction via the MacPath property.
- **caseSenstive** (bool) - Whether or not a case-sensitive comparison should be used when matching against _path_. Can be accessed/changed after construction via the CaseSensitive property.
- **regularExpression** (bool) - If true, denotes that the value in _path_ is a Regular Expresion, and that RegEx matching should be used. Can be accessed/changed after construction via the RegularExpression property.
- **mapPrefixOnly** (bool) - Can be accessed/changed after construction via the MapPrefixOnly property.
```

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

### SlaveEnableIdleUserCheck

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_slaves_1_1_slave_settings.html

Gets or sets a flag to enable checking the running user against a list of allowed users for idle status. If enabled, the Worker will not start if the launcher is running as a user not in SlaveIdleUserNames.

```APIDOC
## SlaveEnableIdleUserCheck

### Description
If enabled, the Worker will not start when the machine is idle if the launcher is running as one of the users in SlaveIdleUserNames.

### Method
GET, PUT

### Endpoint
/api/slaves/{slaveId}/enableIdleUserCheck

### Parameters
#### Request Body (for PUT)
- **enable** (boolean) - Required - True to enable idle user checking.

### Response (for GET)
- **enable** (boolean) - The current status of idle user checking.
```

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

### DeadlineScriptDialog.__init__

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_script_dialog_1_1_deadline_script_dialog-members.html

Initializes a new instance of the DeadlineScriptDialog class. This is the constructor for the dialog.

```APIDOC
## DeadlineScriptDialog.__init__

### Description
Initializes a new instance of the DeadlineScriptDialog class. This is the constructor for the dialog.

### Method
__init__

### Parameters
* **parent** (object) - Optional - The parent widget for this dialog.
```

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

### CreateScriptTempFolder(string prefix)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_scripting_1_1_client_utils-members.html

Creates a temporary folder for scripts with a specified prefix. This is a static method of the ClientUtils class.

```APIDOC
## CreateScriptTempFolder(string prefix)

### Description
Creates a temporary folder for scripts with a specified prefix. This is a static method of the ClientUtils class.

### Method
static

### Endpoint
N/A (Client-side scripting method)

### Parameters
#### Path Parameters
- **prefix** (string) - Description of the prefix for the temporary folder.

### Response
N/A (Creates a folder, does not return a value in this signature)

### Example
```csharp
Deadline.Scripting.ClientUtils.CreateScriptTempFolder("MyScript_");
```
```

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

### SlaveEnableIdleRamPercentThreshold

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_slaves_1_1_slave_settings.html

Gets or sets a flag to enable RAM usage threshold checking (as a percentage) for idle status. If enabled, the Worker will only start if the machine's RAM usage is below the value set in SlaveEnableRamPercentThreshold.

```APIDOC
## SlaveEnableIdleRamPercentThreshold

### Description
If enabled, the Worker will not start when the machine is idle unless the current RAM usage of the machine is lower than the value (as a percentage) in SlaveEnableRamPercentThreshold.

### Method
GET, PUT

### Endpoint
/api/slaves/{slaveId}/enableIdleRamPercentThreshold

### Parameters
#### Request Body (for PUT)
- **enable** (boolean) - Required - True to enable RAM (%) idle threshold checking.

### Response (for GET)
- **enable** (boolean) - The current status of RAM (%) idle threshold checking.
```

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

### GetIniFileSetting

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_scripting_1_1_file_utils-members.html

Retrieves a specific setting from an INI file.

```APIDOC
## GetIniFileSetting

### Description
Retrieves a specific setting from an INI file.

### Method
static

### Parameters
#### Path Parameters
- **fileName** (string) - Required - The name of the INI file.
- **section** (string) - Required - The section name.
- **key** (string) - Required - The key of the setting to retrieve.
- **defaultValue** (string) - Required - The default value to return if the key is not found.

### Response
#### Success Response (string)
Returns the value of the specified setting, or the default value if not found.
```

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

### SlaveEnableIdleRamMBThreshold

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_slaves_1_1_slave_settings.html

Gets or sets a flag to enable RAM usage threshold checking (in Megabytes) for idle status. If enabled, the Worker will only start if the machine's RAM usage is below the value set in SlaveEnableIdleRamMBThreshold.

```APIDOC
## SlaveEnableIdleRamMBThreshold

### Description
If enabled, the Worker will not start when the machine is idle unless the current RAM usage of the machine is lower than the value (in Megabytes) in SlaveEnableIdleRamMBThreshold.

### Method
GET, PUT

### Endpoint
/api/slaves/{slaveId}/enableIdleRamMBThreshold

### Parameters
#### Request Body (for PUT)
- **enable** (boolean) - Required - True to enable RAM (MB) idle threshold checking.

### Response (for GET)
- **enable** (boolean) - The current status of RAM (MB) idle threshold checking.
```

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

### GetConnectionSettings Method

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_script_dialog_1_1_script_repository_selection_dialog.html

Retrieves the Repository root or Connection Server URL/Port specified in the dialog.

```python
def DeadlineScriptDialog.ScriptRepositorySelectionDialog.GetConnectionSettings(_self_)
Gets the Repository root or Connection Server URL/Port that was specified in the dialog.

```

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

### SpawnProcess (executable, arguments)

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_scripting_1_1_process_utils.html

Spawns a new process from the specified executable with the given arguments.

```APIDOC
## SpawnProcess (executable, arguments)

### Description
Spawns a process from the specified executable with the given arguments.

### Method
static Process

### Parameters
#### Path Parameters
- **executable** (string) - Required - The path to the executable file.
- **arguments** (string) - Required - The command-line arguments to pass to the executable.
```

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

### OnSlaveStarted

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_events_1_1_deadline_event_listener.html

Calls the on Worker started callback. This method is triggered when a slave starts.

```APIDOC
## OnSlaveStarted

### Description
Calls the on Worker started callback.

### Method
virtual void

### Parameters
* **slaveName** (string) - The name of the started slave.

### Response
None
```

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

### OnMachineStartupCallback

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_events_1_1_deadline_event_listener.html

This callback is invoked when Power Management initiates the startup of a Worker machine for rendering. It provides the group name and a list of worker names involved in the startup process.

```APIDOC
## OnMachineStartupCallback

### Description
This callback is invoked when Power Management initiates the startup of a Worker machine for rendering. It provides the group name and a list of worker names involved in the startup process.

### Signature
`GenericDelegate3<string, string[], MachineStartupOptions> Deadline.Events.DeadlineEventListener.OnMachineStartupCallback`
```

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

### Slave Started Event

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_events_1_1_deadline_event_listener-members.html

Called when a slave starts. This is a virtual method that can be overridden.

```APIDOC
## OnSlaveStarted

### Description
Called when a slave starts. This is a virtual method that can be overridden.

### Method
virtual

### Endpoint
OnSlaveStarted(string slaveName)
```

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

### OnSlaveStartedCallback

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_events_1_1_deadline_event_listener.html

This callback is invoked when a Deadline worker is started. It provides the name of the started worker.

```APIDOC
## OnSlaveStartedCallback

### Description
If a function is assigned to this callback, it will be called when a Worker is started. The string corresponds to the Worker name.

### Method
GenericDelegate1< string >

### Parameters
#### Path Parameters
- **worker_name** (string) - Required - The name of the started worker.
```

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

### Properties

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/functions_prop_s.html

This section details properties related to machine startup, thermal shutdown, process management, plugin settings, and slave information within the Deadline scripting environment.

```APIDOC
## Properties

This section details properties related to machine startup, thermal shutdown, process management, plugin settings, and slave information within the Deadline scripting environment.

### - s -

*   **SendStartSlaveCommand** : Deadline.PowerMgmt.MachineStartupOptions
    *Description: Controls the command sent to start a slave machine.*

*   **SensorOfflineTimeoutMinutes** : Deadline.PowerMgmt.ThermalShutdownOptions
    *Description: Specifies the timeout in minutes before a sensor being offline triggers a thermal shutdown.*

*   **Sensors** : Deadline.PowerMgmt.ThermalShutdownOptions
    *Description: Represents the sensors used for thermal shutdown monitoring.*

*   **SetHomeVariable** : FranticX.Processes.ManagedProcess
    *Description: Sets a home environment variable for a managed process.*

*   **Settings** : Deadline.Balancer.BalancerInfoSettings, Deadline.Pulses.PulseInfoSettings, Deadline.Slaves.SlaveInfoSettings
    *Description: Accesses settings for Balancer, Pulses, and Slave information.*

*   **ShutdownOverrides** : Deadline.PowerMgmt.IdleShutdownOptions
    *Description: Overrides for idle shutdown behavior.*

*   **ShutdownSlavesIfSensorsOffline** : Deadline.PowerMgmt.ThermalShutdownOptions
    *Description: Determines if slaves should be shut down if sensors go offline.*

*   **SimulateLogin** : FranticX.Processes.ManagedProcess
    *Description: Simulates a login for a managed process.*

*   **SingleFramesOnly** : Deadline.Plugins.DeadlinePlugin
    *Description: Flag indicating if the plugin only processes single frames.*

*   **SlaveComment** : Deadline.Slaves.SlaveSettings
    *Description: A comment associated with slave settings.*

*   **SlaveCompletedTasks** : Deadline.Slaves.SlaveInfo
    *Description: Information about tasks completed by a slave.*

*   **SlaveConcurrentTasksLimit** : Deadline.Slaves.SlaveSettings
    *Description: The limit for concurrent tasks a slave can handle.*

*   **SlaveConfigName** : Deadline.Slaves.SlaveInfo
    *Description: The configuration name of a slave.*

*   **SlaveCpuAffinity** : Deadline.Slaves.SlaveSettings
    *Description: CPU affinity settings for a slave.*

```

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

### OnSlaveStartingJob

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_events_1_1_deadline_event_listener.html

Calls the on Worker starting job callback. This method is invoked when a slave is about to start a job.

```APIDOC
## OnSlaveStartingJob

### Description
Calls the on Worker starting job callback.

### Method
virtual void

### Parameters
* **slaveName** (string) - The name of the slave.
* **job** (Job) - The job the slave is about to start.

### Response
None
```

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

### Slave Starting Job Event

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_events_1_1_deadline_event_listener-members.html

Called when a slave is about to start a job. This is a virtual method that can be overridden.

```APIDOC
## OnSlaveStartingJob

### Description
Called when a slave is about to start a job. This is a virtual method that can be overridden.

### Method
virtual

### Endpoint
OnSlaveStartingJob(string slaveName, Job job)
```

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

### MachineStartupOptions Members

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_power_mgmt_1_1_machine_startup_options-members.html

Lists the available members for the Deadline.PowerMgmt.MachineStartupOptions class. These members control various aspects of machine startup behavior, including wake-on-LAN settings, debug modes, and command execution.

```APIDOC
## Class: Deadline.PowerMgmt.MachineStartupOptions

### Description
This class provides options for configuring machine startup behavior within the Deadline system. It includes settings for wake-on-LAN, debug modes, and command execution.

### Members

#### Properties

- **Command** (string) - Represents a command to be executed during machine startup.
- **DebugMode** (bool) - Enables or disables debug mode for machine startup.
- **DisabledByThermalShutdown** (bool) - Indicates if startup is disabled due to thermal shutdown.
- **Enabled** (bool) - Enables or disables machine startup.
- **MillisecondsBetweenWOLPackects** (int) - Specifies the delay in milliseconds between sending Wake-On-LAN packets.
- **OrderOverrideArray** (string[]) - An array to override the default startup order.
- **OverrideOrder** (bool) - Enables or disables the order override.
- **SendStartSlaveCommand** (bool) - Determines if the 'Start Slave' command should be sent.
- **SlavesToWakeupPerInterval** (int) - The number of slaves to wake up per interval.
- **TargetExtraIdleSlaves** (int) - The number of additional idle slaves to target for startup.
- **WakeOnLan** (bool) - Enables or disables Wake-On-LAN functionality.
```

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

### SearchFileListFor64Bit

Source: https://docs.thinkboxsoftware.com/products/deadline/10.4/2_Scripting%20Reference/class_deadline_1_1_scripting_1_1_file_utils.html

Searches a semicolon-separated list of file paths for the first existing 64-bit file. It checks the current directory and the PATH environment variable for relative paths.

```APIDOC
## SearchFileListFor64Bit

### Description
Searches a semicolon separated list of files for the first 64 bit file that exists. For relative file paths in the list, the current directory and the PATH environment variable will be searched.

### Method
static string

### Parameters
#### Path Parameters
- **fileList** (string) - Required - A semicolon-separated string of file paths to search.

### Response
#### Success Response
- **string** - The path of the first existing 64-bit file found, or an empty string if none are found.
```
Tokens:
Raw