Install Hyperic Agents in Volume

About this page...

This page has recommendations for how to deploy agents in volume in a large Hyperic environment. Before performing the steps below, see Hyperic Installation and Startup Process for information about prerequisite steps. The instructions below are one way to perform Step 4 - Set Up the Hyperic Agent of that process.

Establish Installation Environment

Set up an Install Server

Choose a machine that can access all target platforms from which to perform remote installation. We refer to this as the "install server". On the install server, create a user account, for instance "hyperic", with permissions required to SSH into each target platform without a password.

Establish Environment on Target Platforms

On each platform on which you will install the Hyperic Agent:

  • Create an user account that is identical to the one you created on the install server.

  • Create identical installation directories, for example, /home/hyperic.

Create Standard Agent Properties File

To enable mass agent deployment, you create an agent.properties that defines the agent properties required for the agent to start up and connect with the Hyperic Server. If you supply the necessary information in the properties file, each Hyperic Agent will find its setup configuration at startup, rather querying for it interactively.

For example, you can create a standard agent profile that you can copy to the agent installation, or to a location available to the agent installation.

In a standard agent.properties — one that you can deploy to multiple agents that report to the same Hyperic Server, you do not edit the properties that specify an agent's listen address and port. At first startup, if explicit values for IP address and port are not set, the Hyperic Agent - which detects the network interfaces on the platform - uses the first detected interface as its listen address, and port 2144 or 2443 as its listen port, depending on whether you configure the agent for plain text or SSL communications.

At a minimum, you must define the Hyperic Server address and port. In addition, you can configure optional agent behaviors that are controlled by agent properties. For more information, see Set Up Agent in Properties File.

The first time you start the agent, it will read its properties file for the server connection information, connect to the server, and register itself.

Encrypted values in agent.properties file

If your standard agent.properties contains any encrypted values, you must distribute the file that contains the encryption key, in addition to agent.properties. The encryption key is stored in the agent.scu file in the AgentHome/conf/ directory of the agent installation where the encryption was performed. The agent.scu file must be installed in the same directory on each agent you deploy with the standard properties file.

Perform Remote Agent Installations

Install and Start Agents One-by-One

Follow these steps to install agents one-by-one. To install to all target platforms at once, see Deploy and Start Multiple Agents at Once below.

  1. Log on to your installation account on the install server.

  2. SSH to the remote platform.

  3. Copy the agent archive to the agent host.

  4. Unpack the agent archive.

  5. Copy the agent.properties file to the /.hq directory under the home directory of the standard agent installation user account.

  6. Start the new agent.

Deploy and Start Multiple Agents at Once

Follow these step to install and start the agent on multiple hosts:

  1. Create a hosts.txt file on your install server that maps hostname to IP address for each platform to which you wish to install the agent.

  2. Open a command shell on the install server.

  3. Entering the following commandd in the shell, supplying the correct name of the agent package in the export command:

     
    $ export AGENT=hyperic-hq-agent-4.6.0-x86-linux.tgz 
    $ for host in `cat hosts.txt`; do scp $AGENT $host:</path/to/agent/install> && ssh $host "tar zxf $AGENT && ./hyperic-hq-agent-4.6.0/hq-agent.sh start"; done 

If target hosts have sequential names (for example, host001, host002, host003, etc), you can skip the hosts.txt file and use the seq command like this:

$ export AGENT=hyperic-hq-agent-4.6.0-x86-linux.tgz
$ for i in `seq 1 9`; do scp $AGENT host$i: && ssh host$i "tar zxf $AGENT && ./hyperic-hq-agent-4.6.0/hq-agent.sh start"; done

Verify Successful Agent Startup

After registering itself with the Hyperic Server, an Hyperic Agent runs an auto-discovery scan, and should discover its host platform, and supported managed products running on the platform. Check the Auto-Discovery portlet in the Hyperic Dashboard to verify the the platforms were discovered.

If you have problems, see Troubleshoot Agent and Server Problems.