Quick Start Auto Registration

Overview

This page references Automated Agent Registration and is designed to quickly get you started monitoring hosts with GDMA. Outlined below are the steps necessary to configure an existing GroundWork server to support GDMA agents, and install and configure the agent on Linux and Windows hosts. Solaris installations are similar to Linux, with the exception of the location of the agent directories and certain paths.

Windows GDMA 2.6.1 is now available through GroundWork Support for use in GroundWork Monitor 7.2.0.
As of the Windows GDMA 2.6.1 release, it is possible for a site to run the GDMA service as a non-administrative user, see Windows GDMA as non\-admin user.

CONTENTS

RELATED RESOURCES

WAS THIS PAGE HELPFUL?

1.0 Adding/Changing GDMA Credentials

The credentials used by the deployed GDMA agents needs to be added to the JBoss Application Server so calls to the legacy REST API succeed. By default the server is configured to use the credentials gdma/gdma, however it is recommended to change the password regularly. Follow the steps below on the GroundWork Monitor server to add the credentials to the authentication store.

1.1 Generate and change credentials

Regarding backslash character
Before you start, if the USER or PWD part of the string to be hashed contains a '\' character, start instead at section 1.2 Generate and change credentials (with '\' character) below.

In the properties file the GDMA default password is set to gdma=8ae0d35b1f513c066178c3eaf805a0fa. To change the password you need to first create a MD5 Hex. In the example below we use: {USER}: gdma, {PWD}: #changeME, and the command: echo -n "{USER}:ApplicationRealm:{PWD}"|md5sum

  1. As the root user enter the following command (using the appropriate USER and PWD):
    echo -n gdma:ApplicationRealm:#changeME|md5sum

    Which produces a MD5 Hex value:

    6f46676d7c793eaae2ed13f5bb676a46
  2. Edit the properties file with the following command:
    vi /usr/local/groundwork/jpp/standalone/configuration/application-users.properties
  3. Locate and change the GDMA username and password hash to the new MD5 Hex value (example shown, use your own Hex value):
  4. Save the file. From this point on the requests through the legacy REST API will succeed. Continue at section 2.0 Configuring GDMA.

1.2 Generate and change credentials (with '\' character)

In the case of the USER or PWD part of the string to be hashed contains a '\' character, the '\' characters must be properly escaped before piping to md5sum. For example one might use the netbios naming convention domain\username with a password such as A\gjhjhg. Both '\' characters in this case must be properly escaped before piping to md5sum. Use the string \u005c in every place that you have a '\'.

In the properties file the GDMA default user and password is set to gdma=8ae0d35b1f513c066178c3eaf805a0fa. To change the password you need to first create a MD5 Hex. In the example below we use: {DOMAIN}/{USER}: example.com/gdma, {PWD}: A\gjhjhg, and the command: echo -n "{DOMAIN}{USER}:ApplicationRealm:{PWD}"|md5sum

  1. As the root user enter the following command: (using the appropriate USER and PWD)
    echo -n example.com\u005cgdma:ApplicationRealm:A\u005cgjhjhg|md5sum

    Which produces a MD5 Hex values:

    29aecce20dfaf39c0050696d5d9b9589
  2. Edit the properties file with the following command:
    vi /usr/local/groundwork/jpp/standalone/configuration/application-users.properties
  3. Locate and change the GDMA username and password hash to the new MD5 Hex value: (example shown)
  4. Save the file. From this point on the requests through the legacy REST API will succeed.

2.0 Configuring GDMA

The first section below outlines steps to configure a GroundWork Monitor server as the target server for GDMA results and a source for GDMA configuration data. The next section outlines the configuration for GDMA client servers.

2.1 Configuring the GroundWork Monitor target server

The following steps should be followed for new installations and upgrades. If you are upgrading an existing GDMA target server the following steps may already be in place however should be verified.
  1. Back up the Monarch database
  2. Create port accessibility
  3. Synchronize target server and GDMA monitored hosts clocks
  4. Set up NSCA communication
  5. Freshness Checking
  6. Enable Externals
  7. Set up Auto-Registration Host Group
  8. Set up auto-registration Monarch Group
  9. Add Auto-Registration to auto-registration
  10. Import GDMA host profiles
  11. Add a default contact group to the host templates

2.2 Configuring a client server

If upgrading an existing GDMA client server, start with step 1. Uninstall the legacy client. If this is a new installation, start with step 2. Download the agent.
  1. Uninstall the legacy client
  2. Download the agent
  3. Install the Agent
  4. Commit
  5. Build Externals