A client is a machine on the HQueue farm which can take on jobs assigned by the server.

You can add and manage client machines on the farm using the CLIENTS page on the HQueue web interface. At the top of the page is a list of clients registered on the farm. Here is a summary of the columns in the list:

Column Name	Description
(no name)	Contains a checkbox for selecting the client row. You can apply actions to the selected clients using the buttons at the bottom of the list. To select all the clients, click the checkbox in the header row.
Status (no label)	The current status of the client: = client is available = client is unavailable = client is currently running jobs
Client	The name of the client machine and its IP address. Click on the name to view the machine's profile. If the client needs an upgrade, then a "*NEEDS UPGRADE*" message appears. To upgrade the client, click on the client's checkbox and then click on the Upgrade button at the bottom of the list.
Last Heartbeat	The number of seconds that have passed since the client machine last contacted the HQueue server indicating that it is running. If the client has never contacted the server since the server was started, then the column displays "No Response".
Platform	The machine's operating system and architecture.
CPUs	The number of processors on the client machine and their processor speeds.
Memory	The amount of memory installed on the client machine.
Load	A measure of how busy the machine is. The maximum load value is equal to the number of CPUs. For example, a machine with 4 CPUs and a load of 4.0 means that all CPUs are at 100% usage.
Idle Time	The number of minutes that have passed since the machine received either a mouse or keyboard event from its primary user. In order for the idle time to be reported, the client machine must give the user account running the client daemon access to the X11 server (see 4.4 Reporting a Client's Idle Time ).
Enabled	Whether the machine is enabled to receive jobs when it is available on the farm or not.
Note Threads (no label)	The icon specifies whether a note for the client exists or not: = note thread exist. Hover over to see the latest note. Click to view and edit the full thread. = no thread. Click to add a thread.
Availability	A list of rules that determine when the client is available to process jobs. For more information about client availability rules, see 4.3 Client Availability Rules ).

4.1 Client View Pages

A client view page has indepth information about a specific client.

Client Details

This section holds information about the client and the machine it is installed on.

Availability Rules

This section shows all of the availability rules acting on the client and has buttons to add additonal rules. See 4.3 Client Availability Rules for more information.

Running Jobs and Job History

These sectionss hold information on currently running and previously ran jobs. See 5 Managing Jobs for more information on the contents of the tables.

Notes

This section holds information on the note thread associated with the client. See 7 Managing Note Threads for more information on note threads.

4.2 Adding Clients

See Adding a Linux Client , Adding a Windows Client , and Adding a Mac OSX Client .

4.3 Client Availability Rules

Every client machine on the farm lets the HQueue server know when it is available to process jobs through a set of availability rules. By default, a machine is configured to be available anytime on anyday when it is first added to the farm. You can modify the set of availability rules by going to the CLIENTS page and then clicking on the machine that you want to edit.

At the bottom of the client view page is the Availability subsection which lists the set of rules. An availability rule can be one of two types:

By Time	-	This rule type indicates the time of day and day of the week for when the machine is available to process a job.
By Idle Time	-	This rule type indicates the amount of idle time that must pass before the machine is considered to be available. Idle time is measured as the number of minutes that have passed since the machine last received a keyboard or mouse event from its primary user. This rule type is useful for workstations that have a regular user. In order for this rule to work, the machine must give the user account running the client daemon access to the display server. To do this (on Linux machines), the primary user has to log in and run the following command: xhost +local:

To add a new rule, click on "Add Rule". When there are multiple rules, the HQueue server determines that a client machine is available if at least one of the rules passes.

To delete a rule, click on the "Delete" button beside the rule. You can optionally disable a rule too by checking on the "Disable Rule" checkbox.

4.4 Reporting a Client's Idle Time

In order for a client machine to report its idle time, it must give the user account running the client daemon permission to query the X11 display server (Linux only). To grant access, the primary user must log into the machine and run the following command:

Note that only clients that have "By Idle Time" availability rules must report idle times.

4.5 Restarting Clients

To restart a client machine, go to the CLIENTS page, check the box for the target machine and then click on the 'Restart' button located below the client list. You can restart several clients at once by checking multiple boxes in the list.

This feature uses secure shell (SSH) to remotely connect to the target machine. If restarting fails, make sure that SSH is installed on the client and that the SSH daemon is running.

This feature is currently not supported for Windows clients.

4.6 Upgrading Clients

To upgrade a client machine, go to the CLIENTS page, check the box for the target machine and then click on the 'Upgrade' button located below the client list. You can upgrade several clients at once by checking multiple boxes in the list.

An 'Upgrade' job is submitted and assigned to the target machine. The machine downloads the new client code from the job and then restarts the client daemon.

If a machine is running an older version of the client code, then a *NEEDS UPGRADE* message appears in place of the IP address next to the Hostname in the client column of the clients list.

4.7 Removing Clients

To remove a client machine from the HQueue farm, go to the CLIENTS page, check the box for the target machine and then click on the 'Remove' button located below the client list. You can remove several clients at once by checking multiple boxes in the list.

This feature uses secure shell (SSH) to remotely connect to the target machine and stop the client daemon if it is running. If removing fails, make sure that SSH is installed on the client and that the SSH daemon is running.

Any jobs running on the removed client will eventually be abandoned. Please make sure to cancel all running jobs before removing the client.

---