About Agent Configuration

About this page...

This page has information about agent configuration data - how it is initially supplied, where it is saved, and how to change it.

For information about where agent configuration fits into the Hyperic deployment process, see:

Agent Startup Configuration Data

The configuration choices you must supply for the agent to start up specify where and how it communicates with the Hyperic Server, and vice versa. You can supply these setup values either interactively at first startup, or in the agent's agent.properties file before first startup. For a list of setup properties and definitions, see Communication Properties Reference section of the Set Up Agent in Properties File page.

After the agent and server establish successful communication upon first agent startup:

  • The Hyperic Agent saves the server's connection data in AgentHome/data. The agent creates the /data directory upon first successful startup. On subsequent startups, the agent will look at the connection data stored in its /data directory to determine where and how to connect to the Hyperic Server.

  • The Hyperic Server stores the agent's connection data in the Hyperic database.

Optional Agent Configuration Properties

As described above in Agent Startup Configuration Data, at first successful startup, the agent saves the server connection data in its /data directory, and upon subsequent startups, looks there for the server connection data. If agent finds the server connection data in its /data directory, it does not look at agent.properties for the connection data.

Other agent properties that configure optional features and behaviors are persisted only in agent.properties. For a complete list of agent properties, see Agent Properties.

Supported Locations for agent.properties

agent.properties is installed in AgentHome/conf.

Note however, that agent first honors an external (from the agent installation) location for the properties file: an .hq directory under the home directory of the user under which the agent runs. The agent honors this location for agent.properties so that if you upgrade an agent by installing a full agent package (rather than just updating the agent bundle), you will not lose the configuration settings defined in agent.properties.

You can also ensure that you do not lose agent configuration settings by backing up Agent/conf/agent.properties before installing a full package, and restoring the file after installation.

You can upgrade a 4.x agent by installing an agent bundle only - you can perform this upgrade operation from the Hyperic user interface or using a manual procedure. When you upgrade the agent bundle only, the agent's /conf directory is not updated — this method preserves the agent.properties file within the agent installation through the upgrade.

How to Change Agent Setup Configuration Properties

You configure an agent's setup properties either interactively at first startup, or in agent.properties prior to first startup The properties that relate to where and how to contact the Hyperic server, are saved in the agent's /data directory; those related to how the server can reach the agent are stored in the Hyperic database.

If you need to make changes to those configuration values for an agent at a later time, you can delete the agent's /data directory, edit the agent.setup.* properties in the agent.properties file, and restart the agent. You must use this method if you wish to change the agent's listen port — you cannot change port settings without restarting the agent.

If you prefer to change the startup configuration (other than agent listen port) without having to restart the agent, run the following command in a command shell, while the agent is running.

 
AgentHome/hq-agent.sh setup 

This will allow you to interactively supply new values for the setup properties, as described in Set Up Agent Interactively. This will this cause all properties in the properties file to be re-read, and take effect.