Agent relay installation options
This topic describes the options you need to configure when installing an agent relay.
The following table lists agent relay configuration options. Where Windows and UNIX/Linux options differ, platform-specific information is included.
Agent relay configuration table
|Please enter the directory where you would like to install the agent relay.||
Enter the directory where to install the agent relay. If it doesn't exist, the system prompts you to create it. For example:
|Please enter your java home.||
directory where Java is installed. Ensure that the
JAVA_HOME environment variable points to this
directory. For example:
Deployment Automation 6.3.4 requires JRE 11.0.
Deployment Automation 6.3.3 requires JRE 8.0.
|Enter the name of this relay.||Enter the name of the agent relay. Each agent relay must have a unique name. The default name is agent-relay.|
|Enter the IP or host name which this agent relay should use||Enter the IP address or host name on which the agent relay will listen for HTTP requests coming from agents.|
|Enter the port which this agent relay should proxy HTTP requests on||
Enter the port on which the agent relay will listen for HTTP requests coming from agents. The default port 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.
|Port which this agent relay should use for communication.||Enter the port on which the agent relay will use for JMS-based communications with remote agents. The default port is 7916.|
|Connect the agent relay to a central server?||Specify whether
you want the agent relay to connect to the
server as follows:
Tip: If you aren't sure, accept the default value (Y). To change it later, edit the agentrelay.properties file in the relay_installation\conf directory.
|Enter the IP or hostname of your central server||If you selected Y to connect the agent relay to the server, enter the IP or host name where the agent relay can contact the server.|
|Enter the port which the central server uses for communication||If you selected Y to connect the agent relay to the server, enter the port the server uses to communicate with agents. The default is 7918.|
|Use mutual authentication between the agent, relay and server.||If mutual authentication is required, enter Y. For more information, see Configure SSL mutual authentication.|
|Do you want to install the Agent Relay as Windows service?||
If you are installing the agent relay on Windows, you can install it as a Windows service. The default is N.
To install the agent relay as a Windows service, select Y and specify the options described next.
|Enter a unique service name for the Agent Relay. No spaces please.||(Required for running as a Windows service) Enter a unique name for the service. The default is agentrelay.|
|Enter the user account name including domain path to run the service as (for local use '.\.' before 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 username. The default is .\localsystem.|
|Enter the password for the '.\localsystem' user account.||(Optional for running as a Windows service) Enter a password for the Windows service user account name. The default is no password.|
|Do you want to start the service automatically?||(Required for running as a Windows service) Specify whether or not (y|N) you want the Windows service to be started automatically. The default is N.|
Note: To modify the agent relay settings, edit the agentrelay.properties file in the <relay_installation>\conf directory. You can also manage agent relays through the user interface. See Manage agent relays.