This documentation relates to QuickBuild 13.0.x
Select here if you are using a different version

Build Agent Installation Guide

Supported operating systems

  • Windows 2000/XP/Vista/7/10, Windows server 2003/2008/2012/2016/2019, 32 bit and 64 bit, x86 and IA architecture
  • Linux, 32 bit and 64 bit, x86, PowerPC and S/390 architecture
  • Mac OS X, 32 bit and 64 bit
  • Solaris, 32 bit and 64 bit, Sparc and x86 architecture
  • AIX, 32 bit and 64 bit, PowerPC architecture
  • HP-UX, 32 bit and 64 bit, IA and PARISC architecture
  • FreeBSD, 32 bit and 64 bit, x86 architecture

Memory requirement

  • 64M minimum, 256M recommended

Installation Steps

  1. Make sure QuickBuild server is up and running, login to QuickBuild as administrator and navigate to Grid tab, follow the download build agent link to download the build agent. Extract downloaded file into the directory where the build agent should be installed. Make sure the user running user agent has full access rights to the installation directory.
  2. Make sure you have JDK8 or higher version installed. Download the appropriate JDK version from if needed.
  3. Make sure the java command exists in the system path; if not, you will need to modify the file conf/wrapper.conf under the build agent's installation directory, and point the entry to path of the java command.
  4. Optionally run <agent install dir>/bin/config.bat|sh) to configure build agent properties such as IP address, port number, SSL setting, etc.
  5. Open a command prompt window, switch to folder <agent install dir>/bin, and run command agent.(bat|sh) console to start the agent.

    Follow this guide on how to install the agent as system service so that it auto-starts when machine reboots.

  6. After the agent starts up, it may complain with the message "This build agent is not authorized to join the grid". Upon this, you need to login to QuickBuild server and authorize the agent to join the grid. Refer to Working with Build Grid for how to authorize build agents to join grid.
  7. If the build agent is connected to QuickBuild server correctly, you will see its entry in active node list of the build grid like below by logging in as administrator:

Trouble Shooting

If your agent does not connect with server, please make sure that:

  1. You can telnet to server port from agent machine with below command:
    telnet _<server host name>_ _<server port>_

    Here <server host name> and <server port> has to be extracted from serverUrl in file conf/ of under agent directory.

  2. You can telnet to agent port from server machine with below command:
    telnet <agent ip address> <agent port>
  3. If auto-detected agent ip reported in server console log is incorrect, specify it explicitly by editing conf/ of the agent to add below property:
    ip=_<agent ip address>_
  4. Recently we found a case where QB agent from other subnets connects to server but then times out during initialization (agents from same subnet works fine), and it turns out that server response package is dropped for some reason (maybe the package content matches some pre-set drop rule) across the gateway, and the problem is solved by connecting to server via ssl port so that server response package is encrypted.


Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.