Local Slave Controls

Overview

The Local Slave Controls allow you to control the slave on your machine, as well as configure Idle Detection and the Job Dequeing Mode. You can access the Local Slave Controls from the Launcher’s menu, or from the Tools menu in the Monitor.

../_images/local_slave_controls.png

Note that it is possible for Administrators to disable the Local Slave Controls. If that’s the case, you will see this message when trying to open them.

../_images/local_slave_controls_disabled.png

Slave Controls

This section allows you to view the state of the slave running on your machine. Also, if the slave is rendering, you can see which job it is currently rendering in the list. Finally, you can control the slave on you machine by right-clicking on them in the list.

../_images/local_slave_controls_control.png

More information about the avaiable controls can be found in the Remote Control documentation.

Override Idle Detection

This section overrides the global Slave Scheduling settings for your machine (if there are any). It can be used to start the slave when your machine becomes idle (based on keyboard and mouse activity), and stop the slave when the machine is in use again. Note that Idle Detection is managed by the Launcher, so it must be running for this feature to work.

../_images/local_slave_controls_idle.png

The available Idle Detection settings are as follows:

  • Start Slave When Machine Is Idle For: This option enables Idle Detection, and you can specify the number of minutes without keyboard, mouse or tablet activity before the slave should start.
  • Only Start Slave If CPU Usage Less Than: If enabled, the slave will only start if the machine’s CPU usage is less then the given value.
  • Only Start Slave If Free Memory More Than: If enabled, the slave will only start if the machine has this much free memory available.
  • Only Start Slave If These Processes Are Not Running: If enabled, the slave will not start if any of the listed processes are running.
  • Only Start Slave If Launcher Is Not Running As These Users: If eanbled, the slave will not start if the Launcher process is running as any of the listed users.
  • Stop Slave When Machine Is No Longer Idle: If enabled, the slave will automatically stop when there is keyboard, mouse or tablet activity again.
  • Only Stop Slave If Started By Idle Detection: If enabled, the Slave will only be stopped when the machine is no longer idle if that Slave was originally started by Idle Detection. If the Slave was originally started manually, it will not be stopped.
  • Allow Slave To Finish Its Current Task When Stopping: If enabled, the slave will finish its current task before stopping when the machine is no longer idle. If disabled, the slave wil requeue its current task before stopping so that another slave can render it.

There are some limitations with Idle Detection depending on the operating system:

  • On Windows, Idle Detection will NOT work if the Launcher is running as a service. This is because the service runs in an environment that is separate from the Desktop, and has no knowledge of any mouse or keyboard activity.
  • On Linux, the Launcher uses X11 to determine if there has been any mouse or keyboard activity. If X11 is not available, Idle Detection will NOT work. One such situation is when the launcher is run as a daemon.

Job Dequeuing Mode

This section can be used to control how your slave dequeues jobs.

../_images/local_slave_controls_mode.png

The available dequeing modes are:

  • All Jobs: This is the default behavior. The slave will dequeue any job that it can work on.
  • Only Jobs Submitted From This Slave’s Machine: This option will only allow the slave to dequeue jobs submitted from the same machine. This is a useful way of ensuring that your slave will only render your jobs.
  • Only Jobs Submitted From These Users: This option will only allow the slave to dequeue jobs submitted by the specified users. This is another way of ensuring that your slave will only render your jobs. However, it can also be used to make your slave render jobs from other specific users, which is useful if you’re waiting on the results of those jobs.