Houdini 18.0 HQueue

Managing clients

How to use the web interface or local logins to add, remove, restart, and manage client machines.

On this page

How to

In a web browser, connect to the HQueue server (http://hostname:5000/). Click the Clients icon at the top-right corner of the web interface to go to the clients page.

Tip

Remote management from the web console uses SSH to connect to the client hosts. If remote management fails, make sure sshd (the SSH server process) is installed and running on the host, and that HQueue has the correct username and password for the host (see below).

To...Do this

Add a client from the web interface

  1. On the Clients page, click Add Clients.

  2. Set the Platform to the OS of the new host machine, then click Continue.

  3. On the next page:

    • Enter the hostname of the machine to be added in the Machines field.

    • For the Admin. Username and Admin. Password fields, enter the username and password of an administrator account that exists on the machine. The client software does not need to run as admin, however HQueue needs the administrator account to remotely log into the machine and install the HQueue Client.

  4. Click Add Machines and wait a few seconds. The new host should appear in the client list.

If adding the machine from the HQueue web interface fails with a "Connection Refused" error, refer to this FAQ.

Set rules for when a client is available to the farm

You can have a situation where certain computers are used by people during work hours, but are added to the farm late at night. You can do this automatically using availability rules.

  1. On the Clients page, find the client you want to set the credentials for. Click the hostname to view the client details.

  2. Under Availability, you can add, edit, disable, or delete rules.

    If any of the rules match current conditions, the server will consider the client available to accept jobs.

Restart a client from the web interface

Currently you cannot restart Windows clients from the web console. See how to restart a client locally (below).

  1. On the Clients page, find the client you want to restart in the client list. Check the box at the start of the row for that client.

  2. Click the Restart button below the client list.

    (You can check multiple boxes and then click Restart if you want to restart multiple clients at once.)

Set the username and password used to connect to a client machine

  1. On the Clients page, find the client you want to set the credentials for. Click the hostname to view the client details.

  2. Under Client Details, click Set username and password.

Restart a client when logged into the host machine

If you can connect to the host machine manually, you can restart the HQueue client locally.

Linux

To restart the server on Linux, run:

cd /opt/hqueue
./scripts/hqserverd restart

Mac

To restart the server On macOS, run:

launchctl unload /Library/LaunchDaemons/com.sidefx.hqserver.plist
launchctl load /Library/LaunchDaemons/com.sidefx.hqserver.plis

Windows

To restart the server on Windows, go to Control Panel ▸ Administrative Tools ▸ Services and restart the HQueueServer service.

Upgrade client software from the web interface

If a client is out-of-date, a "needs upgrade" message appears for it in the client list.

  1. Check the box at the start of the row for any clients you need to upgrade.

  2. Click the Upgrade button below the client list.

Remove clients using the web interface

Important: cancel any running jobs on the client before removing it from the client list.

Currently you cannot remove Windows clients from the web console. See how to uninstall the client on the host machine.

  1. On the Clients page, find the client you want to remove in the client list. Check the box at the start of the row for that client.

  2. Click the Remove button below the client list.

    (You can check multiple boxes and then click Remove if you want to remove multiple clients at once.)

Uninstall client software when logged into the host machine

See the uninstalling page.

Client list table

Column

Description

checkboxes

Allows you to select a client. You can apply actions to selected client(s) using the buttons below the list.

dots

The dot color indicates the client’s status.

Green – available

Red – unavailable

Orange – currently running jobs

Dark grey – offline

Client

The host’s DNS name and IP address. Click the name to view the machine’s profile. If the client is out of date, the cell displays a "needs upgrade" message.

Last Heartbeat

The number of seconds since the client machine last contacted the HQueue server. If the client has never contacted the server, the cell displays a "no response" message.

Platform

The host’s operating system and architecture.

CPUs

The number of processors on the host and their speeds.

Memory

The total memory on the host.

Load

A measure of how busy the machine is. The maximum load is equal to the number of CPUs. For example, a machine with 4 CPUs and a load of 4.0 means all CPUs are at 100% usage.

Idle Time

The number of minutes since the host received either a mouse or keyboard event from its primary user (macOS and Linux only). If you are have hosts in your farm that are used by people during work hours, this can give you a sense of whether the host is in use or available.

For Linux hosts, the idle time is reported only if the client machine is configured to grant X11 display server access to the user account running the HQueue client daemon. See the 'By Idle Time' subsection at Client Availability Rules for more details.

Enabled

Whether the machine is allowed to receive jobs or not.

note icon

Indicates whether the client has a note attached to it or not.

Note exists. Hover over the icon to view the note. Click the icon to view the note’s full thread.

No note. Click the icon to add a note.

Availability

A list of rules controlling when the client will accept jobs. See Client Availability Rules.

Viewing Clients

Click the client’s name in the client list to view the machine’s hardware specifications and configuration. General information is located under the Client Details section as shown below.

The following table describes the fields found in the General group box:

Field

Description

Hostname

The client’s machine name.

Status

The client’s status.

Last Heartbeat

The number of seconds that have passed since the client machine last contacted the HQueue server. If the client has not contacted the server since the server started, then the column displays "No Response".

Listen Port

The port number that the client is using to communicate with the server.

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.

Groups

The groups that the client is a member of.

Install Location

The install location of the HQueue client files.

Needs Upgrade

This appears when the client requires an upgrade. Click the Upgrade button next to it to upgrade the client.

IP Address

The machine’s IP address.

Platform

The machine’s operating system and architecture.

CPUs

The number of CPUs on the client machine and their frequency.

Memory

The amount of memory reported by the client machine.

Free Disk Space

The amount of free disk space on the client machine.

Disk Capacity

The total amount of disk space available on the client machine.

Username

The username used to remotely log into the machine. Remote login occurs when restarting the machine from the CLIENTS page.

Password

The password used to remotely log into the machine. It appears as a series of *s if a password is set and as NOT SET if no password is set. Remote login occurs when restarting the machine from the CLIENTS page.

Set Username and Password

Click on this button to change the username and password used to remotely log into the machine. Remote login occurs when restarting the machine from the CLIENTS page.

Client availability rules

The availability of a client machines to take on jobs is determined by a set of rules.

This lets you create a situation where certain computers are used by people during the day, but are automatically added to the farm when nobody’s using them.

Currently there are two rule types:

By time

You can set the client to be available between certain hours (for example, from 11pm to 4am the next day on weeknights, all day on weekends).

For a dedicated render server, you can turn on the Anytime checkbox.

By idle time (Mac and Linux only)

You can set the client to become available when it hasn’t been used interactively for a certain number of minutes. This is only supported for Mac and Linux clients.

Note

On Linux, the host must be configured to grant X11 display server access to the user account running the HQueue client. You can do this by logging into the host as the HQueue client user and running:

xhost +local:

If you edit the rules, make sure to click Save to save the new rules to the client.

HQueue

Getting started

  • About HQueue

    HQueue is a general-purpose job management system. You can use it to distribute renders, simulations, and other work to remote clients.

  • Installation

    How to set up a basic HQueue farm.

  • Configuration

    How to set configuration options for the HQueue server and clients.

  • How to submit jobs

    How to put work on the farm.

Managing the farm

  • Managing clients

    How to use the web interface or local logins to add, remove, restart, and manage client machines.

  • Managing jobs

    How to view and manage jobs on the farm.

  • Managing client groups

    How to use the web interface or local logins to create and manage groups of client machines.

  • Notes

    Each client and job can have informational notes attached.

  • Resources

    You can specify what resources (such as licenses) are available on each client, so jobs can be scheduled on clients where they can run.

  • Network Folders

    How to use the Network Folder management page.

Next steps

  • Logging

    Hqueue stores separate logs for errors and scheduling events, and each client also generates a log.

  • Uninstalling

    How to uninstall the HQueue server or client software.

  • FAQs

    Answers to frequently asked questions.

Guru level

  • Remote API

    You can connect to the HQueue server over the network and call functions to manipulate and query jobs and other information.

  • Jobs specification details

    More detail on the internals of a job specification for users who want to submit custom jobs.

  • Switching to MySQL (Linux only)

    You can optionally configure HQueue to use MySQL instead of SQLite on Linux.