+ SpringSource AMS Documentation : AMS Agent Configuration
This page last changed on Nov 26, 2007 by megbartelt.

Configuring an AMS Agent

The AMS Agent is configured using the agent.properties file found in the top-level Agent directory. Properties may also be specified in a properties file located at .hq/agent.properties in the home directory of the user that runs the AMS Agent. Preferably, configuration changes for the agent should be placed in the .hq/agent.properties file so that the configuration persists through Agent upgrades.

General Agent Configuration

Administrators can configure the following Agent properties:

Property Description
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 AMS 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.

Automatic Agent Set-Up Configuration

AMS can be configured to automatically set up AMS Agents without user input. The configuration properties just below along with example values can be found in the agent.properties file distributed with the AMS Agent.

Property Description
agent.setup.camIP The IP address of the AMS server.
agent.setup.camPort The non-secure HTTP port on the AMS server.
agent.setup.camSSLPort The secure port on the AMS server.
agent.setup.camSecure Set to 'yes' if communications to the AMS server should be secured over SSL. Set to 'no' to use non-secure communication.
agent.setup.camLogin The user within AMS to use when registering this agent.
agent.setup.camPword The password of the user within AMS 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 AMS server. This option does not apply for the initial agent setup. Set to 'no' to use the existing agent token.

Agent Debug-Logging Configuration

DEBUG logging in the AMS Agent can be useful for troubleshooting.

To turn on DEBUG logging in an Agent:

  1. Edit the agent.properties file and change this line:

    to this line:

  2. Restart the Agent.
Debug Logging is Chatty
Debug logging is very verbose and uses more system resources. For these reasons, SpringSource recommends running the Agent in DEBUG mode only when troubleshooting a problem.

Next Steps
Associated UI Pages
Return to the User Manual.
Document generated by Confluence on Apr 02, 2008 20:37