These are instructions for supplying agent configuration settings the first time you start the agent.
1. Make sure that the HQ Server to which the Agent will connect is running.
2. Start the agent from the command line under your user account.
On Windows, install the HQ Agent service, and then start it with these commands:
hq-agent.bat install
hq-agent.bat start
On Unix-based platforms, assuming you have already installed, or unpacked the agent into its installation directory, enter:
AgentInstallationDirectory/bin/hq-agent.sh start
3. When the HQ Agent starts for the first time, it issues the prompts that follow so that it can establish communications with the HQ Server.
| Prompt |
Notes
|
| Should Agent communications to HQ be unidirectional [default=no] |
This prompt only appears if you are installing HQ Enterprise. To understand this option, see Configuring Unidirectional Agent - Server Communications. |
| What is the HQ server IP address |
Enter the listen address of your HQ Server. The server must be running. If the server is on the same machine as the agent, you can enter localhost.
If there is a firewall blocking traffic from the agent to the server, specify the address of the firewall. |
| Should Agent communications to HQ always be secure [default=no]. |
If you want agent and server to communicate via SSL, enter yes. Otherwise, enter Return to accept the default - which is plain HTTP communications. |
| What is the HQ server port [default=7080] |
This prompt appears if you accepted the default for the previous prompt. If your HQ Server is configured to listen on the default port of 7080, press Return.
If there is a firewall blocking traffic from the agent to the server, configure it to forward traffic on TCP port 7080 (or 7443) to the host running the HQ Server. |
| What is the secure HQ server port [default=7443] |
This prompt only appears if you answered yes to "Should Agent communications to HQ always be secure" prompt. If your HQ Server is configured to listen for SSL communications on the default port of 7443, press Return. |
| What is your HQ login [default=hqadmin]: |
By default, the HQ server is initially configured with an administrative account with username hqadmin. Unless you have configured a different HQ user account for agent-server communications, accept the default. |
| What is your HQ password |
Enter the password for the username you supplied at the previous prompt. If you accepted the default admin user password when installing the HQ server, the password is hqadmin. |
| What IP should HQ use to contact the agent [default=n.n.n.n] |
The prompt will show default that is the IP address the agent detected on the host. If there is another IP address on the host you prefer to use, enter it.
If there is a firewall blocking traffic from the server to the agent, enter the IP address of the firewall, and configure the firewall to forward traffic intended for the HQ Agent to the listen address of the agent host. |
| What port should HQ use to contact the agent [default=2144] |
Enter the agent port the HQ Server should use when it initiates contact with the agent. The value you supply to this prompt should be the port that the agent binds to at startup, which by default is 2144.
Note: If your have previously edited agent.properties to explicitly define a different listen port, using the optional agent.listenPort property, that is the value you should supply to this prompt.
If there is a firewall blocking traffic from the server to the agent, configure the device to forward traffic on TCP port 2144 to the HQ Agent. |
Messages similar to the following are displayed upon successful startup of an agent.
Received temporary auth token from agent
Registering agent with HQ
HQ gave us the following agent token
1215038691323-8570363106994871928-8259195015465958356
Informing agent of new HQ server
Validating
Successfully setup agent