4 Managing Clients
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:
4.1 Client View Pages
A client view page has indepth information about a specific client.
This section holds information about the client and the machine it is installed on.
This holds general information about the client. It displays the following properties:
This section holds information about the client machine. It displays the following properties:
This section holds information on what the HQueue server uses to remotely log into the client machine. It displays the following properties:
In this section there is also a 'Set Username and Password' button. Clicking this will bring up a dialog that lets you change the username and password associate with the client. Press the 'Save' button to save the changes to the database and the 'Cancel' button to close the dialog and not make any changes.
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.
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
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:
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.