Install agent relays in silent mode on Windows

This topic describes how to configure and install a Deployment Automation agent relay in silent mode on Windows.

Install an agent relay in silent mode on Windows

To install an agent relay in silent mode on Windows:

  1. Download the agent relay installer for Windows.

  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 the options file you created in step 2.

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 agent relay silent installation options for Windows.

Option Description
AGENT_RELAY_HOME

Enter the directory where you want the agent relay installed. If it does not exist, you will be prompted on whether to create it, for example:
C:\Program Files\Micro Focus\agentrelay

Note: This is the only required option for running the agent relay silent installation. If you specify only this property, the rest of the options will have the default values.

JAVA_HOME 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 on which the agent relay will listen for HTTP requests coming from agents.
PROXY_PORT

Enter the port on which the agent relay will listen for HTTP requests coming from agents. The default is 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 will then automatically connect through HTTPS. Agent relays will automatically use HTTPS when agents request HTTPS links.

AGENT_RELAY_RELAY_PORT Enter the port on which the agent relay will use for JMS-based communications with remote agents. The default port is 7916.
AGENT_RELAY_MUTUAL_AUTH If mutual authentication is required, enter true. For more information, see Configure SSL mutual authentication.
AGENT_RELAY_CONNECT Specify whether you want the agent relay to connect to the Deployment Automation server as follows:

Note: If you aren't sure, accept the default value (true). To change it later, edit the agentrelay.properties file located in the <relay_installation\conf> directory.

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.
INSTALL_SERVICE 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 (Required for running as a Windows service) Enter a unique name for the service. No spaces are allowed. The default is agentrelay.
INSTALL_SERVICE_LOGIN (Required for running as a Windows service) Enter an account name, including the domain path under which to run the service. For a local user, insert ".\" before the user name. The default is .\localsystem
INSTALL_SERVICE_PASSWORD (Optional for running as a Windows service) Enter a password for the Windows service user account name. The default is nopass.
INSTALL_SERVICE_AUTOSTART (Required for running as a Windows service) Specify whether or not (true/false) you want the Windows service to be started automatically. The default is false.

Back to top

Example of silent installation settings in an options file

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
AGENT_RELAY_NAME=Relay123
PROXY_HOST=0.0.0.0
PROXY_PORT=20080
AGENT_RELAY_RELAY_PORT=7916 
AGENT_RELAY_MUTUAL_AUTH=true
AGENT_RELAY_CONNECT=true
AGENT_RELAY_SERVER_HOST=DAServerHost
AGENT_RELAY_SERVER_PORT=7918
INSTALL_SERVICE=true
INSTALL_SERVICE_NAME=sda-relay123
INSTALL_SERVICE_LOGIN=admin01
INSTALL_SERVICE_PASSWORD=password
INSTALL_SERVICE_AUTOSTART=true 

Back to top

See also: