Self-Announcing Netprobes Technical Reference

Introduction

A Self-Announcing Netprobe (SAN) is a Netprobe that is configured to make a connection to a Gateway that has no prior knowledge of the SAN, and provide minimal information to allow monitoring to begin. This section provides options as to how the Gateway handles the connection.

See Netprobe - User Guide for more information on configuring SANs.

Configuration

Basic Configuration

selfAnnouncingProbes > enabled

The enabled setting controls whether the self-announcing probes feature in gateway is enabled or not.

When enabled (set to true), self-announced probes may connect to the gateway, subject to limit checks and filters.

When disabled any self-announced probes which attempt a connection will be rejected. Additionally, any self-announced probes currently connected will be removed and disconnected.

Mandatory: Yes
Default: true (self-announcing probes can connect)

selfAnnouncingProbes > enableReverseConnections

By default, where both components support it, the self-announcing or floating connections are made from the probe to the gateway (unlike normal probes). This is tolerant to network configuration or firewall issues where a probe may be able to announce itself to the gateway but the gateway cannot connect to the probe with the information provided.

In order to disable this feature, and force all netprobe connections to be made in the gateway-to-probe direction this setting can be set false. If this setting is set false then self-announcing or floating probes configured to require reverse connections will reject this gateway.

Mandatory: No
Default: true (connections can be made in the probe-to-gateway direction)

selfAnnouncingProbes > pinSuspendedProbes

This setting controls what happens when a self-announcing or floating probe is suspended, either manually (using the Suspend Probe command) or automatically by the Data Quality feature. It applies only to probes from Geneos version 4.3 upward using 'reverse' connections, that is, connections made from the probe to the gateway.

If a reverse-connnected probe is pinned, which is the default, it will normally wait until the Gateway sends it a message to end the suspension. The Gateway sends this message when the suspension period ends or the "Unsuspend Probe" command is used. If the connection to the Gateway is lost or the Gateway fails to send an unsuspend message within the expected time, the probe will poll all the gateways known to it for a new connection.

If a reverse-connnected probe is not pinned to the gateway that suspends it (or is older than Geneos version 4.3), it will immediately attempt to connect to one of the other gateways listed in its setup file.

Mandatory: No
Default: true (probes are pinned to the gateway that has suspended them.)

selfAnnouncingProbes > probeLimit

The probe limit setting specifies how many self-announcing probes the gateway will accept for monitoring. Once the limit has been reached, further probes which connect will be rejected. A value of zero means that no probes can connect.

If the limit is reduced while the gateway is running, then self-announcing probes will be removed from the gateway until the total number is within the limit. Probes will be removed on a LIFO (last-in first-out) basis, so the most recent self-announcing probes to connect will be the first to be removed.

Mandatory: No
Default: Unlimited

selfAnnouncingProbes > disconnectedProbeTimeout

An optional time out (in seconds) after which any disconnected self-announced netprobe will be removed from the gateway.

Mandatory: No
Default: Probes never time out.
Unit: Seconds

Filters

selfAnnouncingProbes > filters

Filters are used to control which self-announcing probes can connect to the gateway, based on the managed entity attributes specified in the Netprobe setup. At present there are three types of conditionals configurable for filters - And, Or, and Entity attribute comparison.

Filters are checked in the order they are defined in the setup. The first filter that matches the probe then determines what action is taken; whether to allow the probe to connect, or deny it.

If a probe does not match any filters in the list, the catch-all filter action will determine whether the probe is allowed to connect or denied.

Mandatory: No
Default: None, catch-all filter determines behaviour in this case

selfAnnouncingProbes > catch-allFilter

The catch-all filter is used when a self-announcing probe connects, and does not match any of the filters configured in the filter setting. In this case, the action of whether to allow or deny this probe is determined by the value of this setting.

Setting Description
ALLOW Allow the probe connection
DENY Deny the probe connection
Mandatory: Yes
Default: ALLOW

selfAnnouncingProbes > filters > filter > name

This setting specifies the name of the filter. Several filters can have the same name. There is no requirement at the time being for the name to be unique.

Mandatory: Yes

selfAnnouncingProbes > filters > filter > allow

When specified, any probe that matches this filter will be allowed to connect to the gateway.

Mandatory: One of allow or deny must be specified.

selfAnnouncingProbes > filters > filter > deny

When specified, any probe that matches this filter will be denied from connecting to the gateway.

Mandatory: One of allow or deny must be specified.

Filter Types

selfAnnouncingProbes > filters > filter > and

The and filter combines the results from all sub-filters to form the logical conjunction result.

That is, this filter will only match the probe if all sub-filters match the probe, or if there are no sub-filters.

Mandatory: No
Default: When no sub-filters are configured, the filter will match the probe.

selfAnnouncingProbes > filters > filter > or

The or filter combines the results from all sub-filters to form the logical disjunction result.

That is, this filter match the probe if at least one sub-filter matches the probe, or if there are no sub-filters.

Mandatory: No
Default: When no sub-filters are configured, the filter will match the probe.

selfAnnouncingProbes > filters > filter > entityAttributeComparison

The entity attribute comparison filter allows you to specify an attribute in the Managed Entity (of the self-announce probe) to perform a comparison against.

As a contrived example, you can use this to filter all probes in London by specifying the name setting as "City" and the value setting as "London".

Note: This assumes that there are managed entity attributes called "City" that have been configured correctly.

Mandatory: No

selfAnnouncingProbes > filters > filter > entityAttributeComparison > name

The name of the managed entity attribute which will be compared.

If the attribute does not exist on the entity, the filter will behave as if the attribute has an empty string value.

Mandatory: Yes

selfAnnouncingProbes > filters > filter > entityAttributeComparison > comparison

The comparison option

Setting Description
EQUALS The comparison will pass the probe, if the attribute matches the specified value (case-sensitive comparison).
NOT_EQUALS The comparison will pass the probe, if the attribute does not match the specified value (case-sensitive).
Mandatory: Yes

selfAnnouncingProbes > filters > filter > entityAttributeComparison > value

The value to compare the managed entity attribute against.

Mandatory: Yes