Install agent relays in silent mode on Windows

You can configure and install a Deployment Automation agent relay in silent mode on Windows.

Install an agent relay silently

Silent mode uses an options file to run an installation in the background.

To install an agent relay in silent mode on Windows:

  1. Download the agent relay installer for Windows from the Software Licensing and Downloads portal (requires login).

  2. Create an options file, add the agent relay options, and save the file as C:/optionsFile.txt. For details, see Silent installation options for an agent relay.

    Note: Make sure that the options file is in ANSI format. The agent installer does not support UTF.

  3. From a command prompt, run this command:

    install.cmd -silent -options optionsFile.txt

    where optionsFile.txt is your options file.

After you install your agent relay, continue with the next steps in the Installation checklist.

Back to top

Silent installation options for an agent relay

The following table describes the Window agent relay options for silent installation.

Option Description

Enter the directory where to install the agent relay. If it doesn't exist, specify the directory to create, for example:

C:\Program Files\Micro Focus\agentrelay

Note: This is the only required option for the agent relay silent installation. If only this property is included, other options have the default values.


Enter the directory where Java is installed. Ensure that the JAVA_HOME environment variable points to this directory, for example:

C:\Program Files\Micro Focus\common\jre\8.0

AGENT_RELAY_NAME Enter the name of the agent relay. Each agent relay must have a unique name. The default name is agent-relay.
PROXY_HOST Enter the IP address or host name which the agent relay uses to listen for HTTP requests coming from agents.

Enter the port which the agent relay uses to listen for HTTP requests coming from agents. Default: 20080.

Note: Agent relays can also communicate through HTTPS. To enable this communication, configure the server to work through HTTPS and change the external agent link to use HTTPS. Agents then automatically connect through HTTPS. Agent relays automatically use HTTPS when agents request HTTPS links.

AGENT_RELAY_RELAY_PORT Enter the port for the agent relay to use for JMS-based communications with remote agents. Default: 7916.
AGENT_RELAY_MUTUAL_AUTH If mutual authentication is required, enter true. For details, see Configure SSL mutual authentication .
AGENT_RELAY_CONNECT Specify whether you want the agent relay to connect to the Deployment Automation as follows:
AGENT_RELAY_SERVER_HOST If you entered true for AGENT_RELAY_CONNECT, enter the IP or host name where the agent relay can contact the server.
AGENT_RELAY_SERVER_PORT If you entered true for AGENT_RELAY_CONNECT, enter the port the server uses to communicate with agents. The default is 7918.

If you are installing the agent relay on Windows, you can install it as a Windows service. The default value is true. If you specify true, see the following table entries:

  • INSTALL_SERVICE_NAME. Enter a unique name for the service. No spaces are allowed. The default is agentrelay.

  • INSTALL_SERVICE_LOGIN. Enter an account name, including the domain path under which to run the service. For a local user, insert ".\" before the username. The default is .\localsystem.

  • INSTALL_SERVICE_PASSWORD. (Optional) Enter a password for the Windows service user account name. The default is nopass.

  • INSTALL_SERVICE_AUTOSTART. Specify whether or not (true or false) you want the Windows service to be started automatically. The default is false.

Back to top

Options file example

Use the following example of the optionsFile.txt settings to configure agent relay silent installation on Windows.

In this optionsFile.txt, the agent relay named Relay123 is configured to connect to the server on DAServerHost. The mutual authentication mode for the agent relay is activated. The agent relay runs as a Windows service named sda-relay123 that is set to start automatically when the system starts. The admin user account name for the agent relay Windows service is admin01, and the password is password.

AGENT_RELAY_HOME=C:\Program Files\Micro Focus\agentrelay
JAVA_HOME=C:\Program Files\Micro Focus\common\jre\8.0

Back to top

See also: