HQ Agent Configuration
 | Agent Debug Logging See this section for instructions on how to configure your agent for debug logging. |
 | Agent Deployment See HQ Agent Deployment for tips on agent deployment. |
The HQ agent is configured using the agent.properties file found in the top level agent directory. Optionally, properties may also be specified in a properties file located at .hq/agent.properties in the home directory of the user that runs the HQ agent. Preferably, configuration changes for the agent should be placed in the .hq/agent.properties file so that the configuration survives agent upgrades.
The following agent configuration properties are available:
| agent.listenPort | This property specifies the default port for the agent to bind to on startup. This port is used for commands sent from the HQ server to the agent. The default value for this option is 2144. |
| agent.listenIp | This property specifies which IP address to bind to on startup. By default this value is '*', meaning that all IP addresses available on the machine will be bound. |
| autoinventory.defaultScan.interval.millis | This property specifies how often the agent should run the default auto-inventory scan. This type of scan detects servers and platform services, and is not resource intensive. This type of scan typically uses the process table, or the Windows registry. By default this value is set to 90000 milliseconds, or 15 minutes. |
| autoinventory.runtimeScan.interval.millis | This property specifies how often the agent should run a runtime scan. This type of scan may use more resource intensive methods to detect services such as issuing an SQL query, or looking up an MBean. Because of this the scan interval is set to 86400000 milliseconds, or 1 day. |
| agent.javaOpts | This property allows extra parameters to be passed to java when starting the agent process. |
Auto-configure agent connection properties
The following agent configuration properties can be used to automatically setup agents without needing user input. The table below details the options. These options along with example values can be found in the agent.properties file distributed with the HQ agent.
| agent.setup.camIP | The IP address of the HQ server. |
| agent.setup.camPort | The non-secure HTTP port on the HQ server. |
| agent.setup.camSSLPort | The secure port on the HQ server. |
| agent.setup.camSecure | Set to 'yes' if communications to the HQ server should be secured over SSL. Set to 'no' to use non-secure communication. |
| agent.setup.camLogin | The user within HQ to use when registering this agent. |
| agent.setup.camPword | The password of the user within HQ to use when registering this agent. |
| agent.setup.agentIP | The agent IP the server should use to contact the agent. |
| agent.setup.agentPort | The agent port the server should use to contact the agent. |
| agent.setup.resetupTokens | Set to 'yes' to resetup the token that is used to authenticate with the HQ server. This option does not apply for the initial agent setup. Set to 'no' to use the existing agent token. |
Configuring the HQ Agent for Debug Logging
Many times when troubleshooting a problem, it is useful to turn on DEBUG logging in the HQ Agent. To turn on debug logging in the agent, edit the agent.properties file and change this line:
agent.logLevel=INFO
To this line:
agent.logLevel=DEBUG
Then, restart the agent for the change to take effect.
| Debug logging is very verbose and uses more system resources. For these reasons, it is recommended to run the agent with this configuration only when troubleshooting a problem. |