Configuring the Geneos Gateway for Solace Routers

Use the Gateway Setup Editor in an ITRS Active Console to configure the Geneos Gateway that manages the connection to your Solace router.

Tip:  To access the Gateway Setup Editor, launch Active Console, then, in the Gateways area, double-click your Geneos Gateway for a Solace router.

Using the Gateway Setup Editor, you must perform the following steps to configure the Geneos Gateway for the Solace router:

Step 1: Install the Solace Include Files

Step 2: Copy Event Log Samplers and Rules to the Main Setup File

Step 3: Copy the FKM Tables to the Main Setup File

Step 4: Create the Solace Sampler

Step 5: Create a NetProbe

Step 6: Create the Managed Entity

Step 1: Install the Solace Include Files

To install the Solace include files provided with the SolGeneos Agent package, do the following:

  1. From the SolGeneos Agent package that was extracted to the /usr/sw directory on the Solace router, copy the following files to a location where they can be read by the Gateway process.
    • solgeneos/loads/<version>/templates/eventlogsampler/ solace_event_log_sampler_config.xml
    • solgeneos/loads/<version>/templates/eventlogsampler/ solace_fkm_config.xml
    • solgeneos/loads/<version>/templates/eventlogsampler/solace_event_log_sampler_config_VMR.xml

      Note:  This file is required to monitor a VMR.

  2. In the Gateway Setup Editor, click Includes in the Navigation area.

  3. A Confirmation dialog box appears to ask whether you want to include files, click Yes.
  4. In the Includes view, click the Advanced tab, and then click Add New.

  5. In the Priority box, enter a priority level of 2, and in the Location box, enter the full path and file name for the solace_event_log_sampler_config.xml (or the solace_event_log_sampler_config_vmr.xml file for a VMR).

  6. Click Add New, and in the new row, enter a priority level of 3 in the Priority box, and in the Location box, enter the full path and file name for the solace_fkm_config.xml.
  7. Click File > Save to save the updates.
  8. Click File > Exit.

Step 2: Copy Event Log Samplers and Rules to the Main Setup File

After including the configuration files, the event log samplers and rules that they provide must be copied to the Samplers and Rules folders.

To copy the sampler and rules to the main setup file, do the following:

  1. In the Gateways area of the Active Console, double-click the Geneos Gateway that manages the connection to your Solace router.

    The Gateway Setup Editor appears.

  2. In the Navigation area of the Gateway Setup Editor, navigate to the Solace Event Log Sampler file that is located in the Samplers folder of the included solace_event_log_sampler_config.xml file (or the solace_event_log_sampler_config_vmr.xml file for a VMR), and copy the Solace Event Log Sampler file.

  3. Scroll down to the Samplers folder, and paste in the Event Log Sampler file.

  4. Navigate to the Rules folder of the included solace_event_log_sampler_config.xml file (solace_event_log_sampler_config_vmr.xml file for a VMR), and copy all of the rules in that folder.

  5. Scroll down to the Rules folder, and paste in the copied rules.

  6. Click File > Save.

Step 3: Copy the FKM Tables to the Main Setup File

After including the config files, you must copy the contents of the included solace_fkm_config.xml file and paste it to the FKM section for the main setup file.

To copy the solace_fkm_config.xml file to the main setup file, do the following:

  1. In the Navigation area of the Gateway Setup Editor, open the Includes folder, and click the solace_fkm_config.xml file to load the file.

  2. Under the newly loaded solace_fkm_config.xml file, navigate to the Solace <version> folder that is located in the FKM subdirectory of Static Variables, and copy the files in the Solace <version> folder.

  3. Navigate to the FKM subdirectory of Static Variables that is located in the main setup file, and paste in the files copied from the included Solace <version> folder.

  4. Click File > Save.

Step 4: Create the Solace Sampler

A Sampler Object defines a set of views that a NetProbe gathers from a particular managed entity. The Solace Sampler exposes all of the Solace views.

To create the Solace Sampler in the Gateway Setup Editor, do the following:

  1. In the Navigation area, select the Samplers folder.

    The Sampler view displays.

  2. In the Sampler view, click New Sampler.
  3. In the Name box, type SolaceSampler.
  4. Select Plugin, and choose API from the list.
  5. Click File > Save.

Step 5: Create a NetProbe

A NetProbe is the data collection point for the system and is associated with Gateway objects. At least one NetProbe is required per managed router.

To create a NetProbe in the Gateway Setup Editor, do the following:

  1. In the Navigation area, select the Probes folder

    The Probes view displays.

  2. In the Probes view, click New Probe.
  3. On the Basic tab, type the router name in the Name box.
  4. In the Hostname box, type the IP address of the Solace router, specified in the dotted decimal notation form (nnn.nnn.nnn.nnn).
  5. In the Port box, type the NetProbe port number of the router’s NetProbe service. The default setting is 7036.
  6. Click File > Save.

Step 6: Create the Managed Entity

Managed entities represent any hardware or software component being monitored. The user is responsible for creating and naming the Solace router managed entity on the Gateway, and associating it with a NetProbe running on that router or off the router.

At least one managed entity is required per managed router.

To create a managed entity for the Solace router in the Gateway Setup Editor, do the following:

  1. In the Navigation area, select the Managed Entities folder.

    The Managed Entities view displays.

  2. In the Managed Entities view, click New Managed Entity.

  3. On the Basic tab, type the Managed Entity’s name in the Name box.

    Note:  This name must precisely match the string on the managedEntities line in the router’s solgeneosagent.properties file (for example, managedEntities=[np0,lab-130-20_ManEnt]).

  4. For Options, select Probe and the hostname of the Solace router that is being monitored by the associated NetProbe.
  5. For Sampler, select the listed Samplers that you want to use with the Managed Entity.

    Note:  For VMR event log sampling, you must use the VMR specific Solace Event Log Sampler.

  6. Click File > Save.