Contains settings for the Worker. In contrast to SlaveInfo, this class contains information usually set by the user or external source meant for the worker. It's not meant to change often. More...

Inherits LastWriteDocument, and ICloneable.

Public Member Functions
string[]	GetSlaveExtraInfoKeys ()
	Gets the keys for the Worker's extra info entries. More...

string	GetSlaveExtraInfoKeyValue (string key)
	Gets the extra info value for the given key. More...

string	GetSlaveExtraInfoKeyValueWithDefault (string key, string defaultValue)
	Gets the extra info value for the given key. More...

void	SetSlaveGroups (object groups)
	Sets the groups that the Worker has been assigned to. More...

void	SetSlaveIdleProcessNames (object processNames)
	The Worker will not start when the machine is idle if any processes in this list are currently running on the machine. More...

void	SetSlaveIdleUserNames (object userNames)
	If user checking is enabled, the Worker will not start when the machine is idle if the launcher is running as this user. More...

void	SetSlavePools (object pools)
	Sets the pools that the Worker has been assigned to. More...

void	SetSlaveUserJobsModeNames (object userNames)
	If SlaveSchedulingMode is set to SlaveSchedulingMode.UserJobs, it will only render jobs for users in this list. More...

Properties
string	SlaveComment `[get, set]`
	Brief comment regarding the Worker. More...

int	SlaveConcurrentTasksLimit `[get, set]`
	Limit the number of concurrent tasks the Worker can dequeue. The value must be between 0 and 16 inclusive. Set to 0 to use the Worker's processor count. More...

int[]	SlaveCpuAffinity `[get, set]`
	The list of specific CPUs to use if SlaveOverrideCpuAffinity is True. More...

string	SlaveDescription `[get, set]`
	A description of the Worker. More...

bool	SlaveEnabled `[get, set]`
	If the Worker is enabled. More...

bool	SlaveEnableIdleCpuThreshold `[get, set]`
	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. More...

bool	SlaveEnableIdleProcessCheck `[get, set]`
	If enabled, the Worker will not start when the machine is idle if any processes in SlaveIdleProcessNames are currently running on the machine. More...

bool	SlaveEnableIdleRamMBThreshold `[get, set]`
	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. More...

bool	SlaveEnableIdleRamPercentThreshold `[get, set]`
	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. More...

bool	SlaveEnableIdleUserCheck `[get, set]`
	If enabled, the Worker will not start when the machine is idle if the launcher is running as one of the users in SlaveIdleUserNames. More...

string	SlaveExtraInfo0 `[get, set]`
	One of the Worker's ten Extra Info fields. More...

string	SlaveExtraInfo1 `[get, set]`
	One of the Worker's ten Extra Info fields. More...

string	SlaveExtraInfo2 `[get, set]`
	One of the Worker's ten Extra Info fields. More...

string	SlaveExtraInfo3 `[get, set]`
	One of the Worker's ten Extra Info fields. More...

string	SlaveExtraInfo4 `[get, set]`
	One of the Worker's ten Extra Info fields. More...

string	SlaveExtraInfo5 `[get, set]`
	One of the Worker's ten Extra Info fields. More...

string	SlaveExtraInfo6 `[get, set]`
	One of the Worker's ten Extra Info fields. More...

string	SlaveExtraInfo7 `[get, set]`
	One of the Worker's ten Extra Info fields. More...

string	SlaveExtraInfo8 `[get, set]`
	One of the Worker's ten Extra Info fields. More...

string	SlaveExtraInfo9 `[get, set]`
	One of the Worker's ten Extra Info fields. More...

Dictionary< string, string >	SlaveExtraInfoDictionary `[get, set]`
	A dictionary of Extra Info KVPs. More...

bool	SlaveFinishTaskWhenStoppingIfNotIdle `[get, set]`
	If a Worker should finish its current task before shutting down when the machine is no longer idle. More...

int[]	SlaveGpuAffinity `[get, set]`
	The list of specific GPUs to use if SlaveOverrideGpuAffinity is True. More...

string[]	SlaveGroups `[get]`
	The groups that the Worker has been assigned to. More...

string	SlaveHostMachineIPAddressOverride `[get, set]`
	If non-empty, this host name or IP address will be used for remote communication with the Worker. More...

int	SlaveIdleCpuThreshold `[get, set]`
	If CPU threshold checking is enabled, the Worker will not start when the machine is idle unless the current CPU usage of the machine is lower than this value. More...

int	SlaveIdleMinutes `[get, set]`
	The number of minutes a Worker must be idle for. More...

string[]	SlaveIdleProcessNames `[get]`
	The Worker will not start when the machine is idle if any processes in this list are currently running on the machine. More...

long	SlaveIdleRamMBThreshold `[get, set]`
	If RAM MB threshold checking is enabled, the Worker will not start when the machine is idle unless the current RAM usage of the machine is lower than this value (in Megabytes). More...

int	SlaveIdleRamPercentThreshold `[get, set]`
	If RAM Percent threshold checking is enabled, the Worker will not start when the machine is idle unless the current RAM usage of the machine is lower than this value (as a percentage). More...

string[]	SlaveIdleUserNames `[get]`
	If user checking is enabled, the Worker will not start when the machine is idle if the launcher is running as this user. More...

int	SlaveListeningPort `[get, set]`
	The port to use listen on if SlaveOverridePort is enabled. More...

string	SlaveMacAddressOverride `[get, set]`
	If non-empty, this is used to override the MAC address for the Worker. More...

string	SlaveName `[get, set]`
	The Worker name. More...

float	SlaveNormalizedRenderTimeMultiplier `[get, set]`
	Used to calculate the normalized render time of the Worker. The value must be between 0.01 and 100.0 inclusive. More...

float	SlaveNormalizedTimeoutMultiplier `[get, set]`
	Used to calculate the normalized timeout for the Worker. The value must be between 0.01 and 100.0 inclusive. More...

bool	SlaveOnlyStopSlaveIfStartedByIdleDetection `[get, set]`
	Only stops the slWorkerave if it was started by idle detection. More...

bool	SlaveOverrideCpuAffinity `[get, set]`
	Enable to override the Worker's CPU affinity (Windows and Linux only). More...

bool	SlaveOverrideGpuAffinity `[get, set]`
	Enable to override the Worker's GPU affinity. More...

bool	SlaveOverrideListeningPort `[get, set]`
	If Worker should listen on a specific port. More...

bool	SlaveOverrideSlaveScheduling `[get, set]`
	If the Worker settings should override the global Worker Scheduling settings. More...

string[]	SlavePools `[get]`
	The pools that the Worker has been assigned to. More...

SlaveSchedulingMode	SlaveSchedulingMode `[get, set]`
	Scheduling modes for a Worker, which affects how it dequeues jobs. If set to SlaveSchedulingMode.UserJobs, it will only render jobs for users in the SlaveUserJobsModeNames list. More...

bool	SlaveStartSlaveIfIdle `[get, set]`
	Starts the Worker if the machine has been idle for the number of minutes specified in SlaveIdleMinutes. More...

bool	SlaveStopSlaveIfNotIdle `[get, set]`
	Stops the Worker if the machine is no longer idle. More...

string[]	SlaveUserJobsModeNames `[get]`
	If SlaveSchedulingMode is set to SlaveSchedulingMode.UserJobs, it will only render jobs for users in this list. More...

Detailed Description

Contains settings for the Worker. In contrast to SlaveInfo, this class contains information usually set by the user or external source meant for the worker. It's not meant to change often.

Member Function Documentation

◆ GetSlaveExtraInfoKeys()

string [] Deadline.Slaves.SlaveSettings.GetSlaveExtraInfoKeys ( )

Gets the keys for the Worker's extra info entries.

Returns: The keys, as a list of strings.

◆ GetSlaveExtraInfoKeyValue()

string Deadline.Slaves.SlaveSettings.GetSlaveExtraInfoKeyValue ( string key )

Gets the extra info value for the given key.

Parameters

key The key.

Returns: The value as a string. If the key isn't found, an empty string is returned.

◆ GetSlaveExtraInfoKeyValueWithDefault()

string Deadline.Slaves.SlaveSettings.GetSlaveExtraInfoKeyValueWithDefault	(	string	key,
		string	defaultValue
	)

Gets the extra info value for the given key.

Parameters

key	The key.
defaultValue	The default value

Returns: The value, as a string. If the key isn't found, an empty string is returned.

◆ SetSlaveGroups()

void Deadline.Slaves.SlaveSettings.SetSlaveGroups ( object groups )

Sets the groups that the Worker has been assigned to.

Parameters

groups The groups. This should be a list of strings.

◆ SetSlaveIdleProcessNames()

void Deadline.Slaves.SlaveSettings.SetSlaveIdleProcessNames ( object processNames )

The Worker will not start when the machine is idle if any processes in this list are currently running on the machine.

Parameters

processNames The process names. This should be a list of strings.

◆ SetSlaveIdleUserNames()

void Deadline.Slaves.SlaveSettings.SetSlaveIdleUserNames ( object userNames )

If user checking is enabled, the Worker will not start when the machine is idle if the launcher is running as this user.

Parameters

userNames The user names. This should be a list of strings.

◆ SetSlavePools()

void Deadline.Slaves.SlaveSettings.SetSlavePools ( object pools )

Sets the pools that the Worker has been assigned to.

Parameters

pools The pools. This should be a list of strings.

◆ SetSlaveUserJobsModeNames()

void Deadline.Slaves.SlaveSettings.SetSlaveUserJobsModeNames ( object userNames )

If SlaveSchedulingMode is set to SlaveSchedulingMode.UserJobs, it will only render jobs for users in this list.

Parameters

userNames The user names. This should be a list of strings.

Property Documentation

◆ SlaveComment

string Deadline.Slaves.SlaveSettings.SlaveComment

getset

Brief comment regarding the Worker.

◆ SlaveConcurrentTasksLimit

int Deadline.Slaves.SlaveSettings.SlaveConcurrentTasksLimit

getset

Limit the number of concurrent tasks the Worker can dequeue. The value must be between 0 and 16 inclusive. Set to 0 to use the Worker's processor count.

◆ SlaveCpuAffinity

int [] Deadline.Slaves.SlaveSettings.SlaveCpuAffinity

getset

The list of specific CPUs to use if SlaveOverrideCpuAffinity is True.

◆ SlaveDescription

string Deadline.Slaves.SlaveSettings.SlaveDescription

getset

A description of the Worker.

◆ SlaveEnabled

bool Deadline.Slaves.SlaveSettings.SlaveEnabled

getset

If the Worker is enabled.

◆ SlaveEnableIdleCpuThreshold

bool Deadline.Slaves.SlaveSettings.SlaveEnableIdleCpuThreshold

getset

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.

◆ SlaveEnableIdleProcessCheck

bool Deadline.Slaves.SlaveSettings.SlaveEnableIdleProcessCheck

getset

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

◆ SlaveEnableIdleRamMBThreshold

bool Deadline.Slaves.SlaveSettings.SlaveEnableIdleRamMBThreshold

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 (in Megabytes) in SlaveEnableIdleRamMBThreshold.

◆ 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.

◆ SlaveEnableIdleUserCheck

bool Deadline.Slaves.SlaveSettings.SlaveEnableIdleUserCheck

getset

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