Internal documentation only
This page has been marked as a draft.
Floating Netprobes
Overview Copied
This topic walks you through the configuration and basic features of floating Netprobes.
Configuration settings Copied
Consider the following setup file for a floating Netprobe:
<?xml version="1.0" encoding="ISO-8859-1"?>
<netprobe>
<floatingProbe>
<enabled>true</enabled>
<retryInterval>60</retryInterval>
<requireReverseConnection>false</requireReverseConnection>
<probeName>myFloatingProbe</probeName>
<gateways>
<gateway>
<hostname>gateway1</hostname>
<port>17101</port>
<secure>false</secure>
</gateway>
</gateways>
</floatingProbe>
</netprobe>
| Element | Sub-element | Sub-element | Description |
|---|---|---|---|
| floatingProbe |
Setup values for the Floating Netprobe mode. Mandatory: No |
||
| floatingProbe > | enabled |
Enables or disables the Floating Netprobe mode. Mandatory: Yes |
|
| floatingProbe > | retryInterval |
Time in seconds that the Netprobe waits after failing to announce itself to a Gateway, or after the master connection is dropped, before restarting the announcing process.
Mandatory: No
Default value:
60
|
|
| floatingProbe > | requireReverseConnection |
When set to By default, floating Netprobes make Netprobe-to-Gateway connections where both components support it. This setting ensures that theNetprobe will not select a Gateway that does not support reverse connections. The default value for this depends upon whether the Netprobeis configured to connect to a secure Gateway. If any of the Gateway connections have the secure flag set to Mandatory: No Default: Dependent on other settings |
|
| floatingProbe > | probeName |
Specifies the name of this Netprobe. The probe
must already have been configured as a
Mandatory: Yes |
|
| floatingProbe > | gateways |
The Gateway or Gateways to which the floating Netprobe should connect. Up to two Gateways are allowed. If two are set then they must be a hot-standby pair. Mandatory: Yes, at least one Gateway must be configured. |
|
| floatingProbe > | gateways | gateway > hostname |
The host name of the Gateway to which the Netprobe should connect. Mandatory: Yes |
| floatingProbe > | gateways | gateway > port |
The listen port of the Gateway to which the Netprobe should connect. Default: Mandatory: No |
| floatingProbe > | gateways | gateway > secure |
Flag to indicate if the probe should use a secure or an insecure protocol when connecting to the Gateway.
Mandatory: No
Default: false
|
OS environment variables Copied
Beginning Geneos 5.3.x, the Netprobe setup file supports using macros to access environment variables available to the host platform.
The syntax for the new macro is [[$env:VARIABLE_NAME]].
The Netprobe evaluates environment variables only once during its lifecycle. That is, during a Netprobe process startup and restart.
If an environment variable cannot be determined, then the macro remains unresolved.
Environment variables abide by OS-specific rules, precedence, and profiles.
Linux environment variables Copied
On Linux, you can use any available environment variables. For example, if the value of $SHELL in the Linux environment is /bin/bash, then [[$env:SHELL]] resolves to /bin/bash in the Netprobe setup file.
Linux variables are case-sensitive.
Windows environment variables Copied
On Windows, you can use any user environment variable defined under Environment Variables in System Properties.
Windows environment variables are case-insensitive.
If the Netprobe is run as a Windows service, then it evaluates the environment variable macros using the environment values defined at startup.
Connection rules Copied
Reasons for rejection Copied
Gateway may refuse to accept a floating Netprobe for a few reasons. For more information, see Rejection reasons.
Hot standby Gateways Copied
Where hot standby Gateway pairs are used, both should be specified in the Netprobe setup file. A non-active Gateway will refuse to accept the Netprobe, so there is no risk of the Netprobe choosing a secondary Gateway while the primary is still up.
For more information on Gateway hot standby behaviour, see Hot Standby.