Netprobe variables

Used in auto-discovery. Available in Netprobes beginning Geneos 5.x.

When enabled, JSON metadata is written on the Netprobe log in the form of the Netprobe XML setup, both raw and resolved.

For more information, see Auto-discovery in Netprobe Overview.

Default value: false

If set to true, stops the Netprobe from restarting due to the limits imposed by MEM_PROTECTION_RATIO.

Default value: false

Available only in the Windows registry.

Specifies where the Netprobe looks for its resource libraries. This registry key is analogous to the LD_LIBRARY_PATH environment variable in Linux platforms.

DLL_PATH can be used as an alternative to PATH when upgrading live Netprobe implementations. When this key is set, then it overrides the PATH environment variable, and the PATH environment variable is ignored.

You can specify multiple paths on they key value. The values must be semicolon-delimited.

DLL_PATH requires you to restart the Netprobe service to take effect.

The Netprobe error and log file. If the filename is not defined, the errors and messages are sent to standard output. Ensure that the directory where the log file resides is writeable, so that the Netprobe can create and write to the file.

Note

• This parameter is ignored if the Netprobe executable is run with the -nolog command-line option.
• If the Netprobe software has been installed on a shared drive and is being run on more than one machine at the same time, see Log files in Install a Netprobe on a shared drive for important information regarding the setting of this variable.
• A full path can be specified in this variable if you wish to place this log file in a specific directory. If only the name is specified, then it will be created in the directory where the Netprobe is running.

The log time format used to record the timestamp that begins each line of the log file.

Possible values:

• (default) ISO-8601: 2019-09-25 09:18:28.871-0400
• ISO-8601-UTC: 2019-09-25 13:18:28.871Z
• LEGACY: <Wed Sep 25 09:18:28>

The Netprobe error and log file can be set up to roll over to a new log file when it gets bigger than the MAX_LOG_FILE_SIZE_MB set.

The maximum value that can be set is 4096 MB, and the minimum is 1 MB. If the value is outside of these ranges or the input is invalid, then the default of 10 MB will be used. This is the equivalent of the advanced Gateway Setup File setting maxLogFileSize.

Limits the Netprobe to a memory equal to the MAX_MEM_SIZE.

For example, if MAX_MEM_SIZE is 500 MiB, then the Netprobe restarts when its memory reaches 500 MiB.

By default, the Netprobe does not check if it reaches a certain memory limit.

Check is done every 30 seconds.

Default value: 0

Unit: mebibytes (MiB)

Maximum allowable value: 1024 MiB

Limits the Netprobe to a memory equal to its starting memory multiplied by the MEM_PROTECTION_RATIO.

Check is done every 10 minutes after a Netprobe starts or restarts.

For example, if the Netprobe starts with 50 MiB of memory and the MEM_PROTECTION_RATIO is 3, then the Netprobe restarts when its memory reaches 150 MiB.

Default value: 2

Allowable range: 2 - 5

Specifies the minimum TLS version. The accepted values are the following:

• 1

• 1.0

• 1.1

• 1.2

• 1.3

Default value: 1.0

The log file generated by Netprobe will grow up to 1 MB. The Netprobe will then rename the file by adding a .old extension and will open a new log file. If the LOG_ARCHIVE_SCRIPT is set, then the Unix script defined by the environment variable will be called after the log file has been renamed. The script parses the name of the .old file as a parameter. This script can be used to archive the log files into an archive area. By default, the script is not called.

These two variables are used to control the use of passwords in relation to Netprobe commands. For more information on using these variables, see Set passwords on Netprobe commands, which also explains the alternative method of setting the password via the Gateway Setup.

The `TRUSTED_GATEWAY_HOSTS` and `TRUSTED_GATEWAY_NAMES` variables are comma-separated lists containing one or more trusted hostnames or IP addresses or names of Gateways. If set, the Netprobe will accept connection from any of these Gateways.

By default, these variables are set to +, which means that all connections are accepted. You are not required to set both variables, but if you do, then any connections must match TRUSTED_GATEWAY_HOSTS and TRUSTED_GATEWAY_NAMES.

If a connection fails to match, then a warning message is logged on the Netprobe, all connected Gateways, and Active Console Event Tickers.

For security, you can only set these variables in the start-up environment on the machine running the Netprobe. You cannot configure them as part of the Netprobe on the Gateway.

If you have set TRUSTED_GATEWAY_HOSTS, the Netprobe checks the source IP of any connections against the list of hostnames and IP addresses. If an explicit IP address fails to match, then the Netprobe will try a reverse DNS lookup of the source IP by checking if any hosts in the list match. If the previous check still fails, then the Netprobe will check each hostname in the list and check the first returned IP address. Hostnames with multiple A records may not be validated correctly.

If a connection is permitted after the TRUSTED_GATEWAY_HOSTS check, then the Netprobe will check the name that the Gateway supplies against TRUSTED_GATEWAY_NAMES. If there is no match, then the connection is dropped, and an error message is logged.

By default, this variable is set to +, which means that all connections are accepted.

If a connection fails to match, then a warning message is logged on the Netprobe, all connected Gateways, and Active Console Event Tickers.

For security, you can only set this variable in the start-up environment on the machine running the Netprobe. You cannot configure them as part of the Netprobe on the Gateway.

If you have set TRUSTED_HTTP_HOSTS, the Netprobe checks any connections against the list of hostnames and IP addresses. If an explicit IP address fails to match, then the Netprobe will try a reverse DNS lookup by checking if any hosts in the list match. If the previous check still fails, then the Netprobe will check each host in the list and check the first returned IP address.

The TRUSTED_DEBUG_HOSTS variable is a comma-separated list containing one or more trusted hostnames or IP addresses of the debug hosts. If set, the Netprobe will accept connection from any of these debug hosts.

By default, the trusted debug host is 127.0.0.1. If this variable is set to +, then any HTTP host is trusted.

If a connection fails to match, then a warning message is logged on the Netprobe. For example,

WARN: ORB Non-trusted host itrslp003 rejected. Trusting only (127.0.0.1) for HTTP Debug components.

For security, you can only set this variable in the start-up environment on the machine running the Netprobe. You cannot configure them as part of the Netprobe on the Gateway.

If you have set TRUSTED_DEBUG_HOSTS, the Netprobe checks any connections against the list of hostnames and IP addresses. If an explicit IP address fails to match, then the Netprobe will try a reverse DNS lookup by checking if any hosts in the list match. If the previous check still fails, then the Netprobe will check each host in the list and check the first returned IP address.

• RMSPUT to enable PUT
• RMSGET to enable GET
• RMSEXEC to enable EXEC

Permissions can be combined using a plus sign. So, for example, to enable PUT and EXEC, set PERMISSIONS to RMSPUT+RMSEXEC.

Alternatively, PERMISSIONS can be set to RMSALL to enable all.

This is the equivalent of the advanced Gateway Setup File setting permissions.

By default, this variable is set to +, which means that all connections are accepted. For more information, see XML-RPC Instrumentation API.

If a connection fails to match, then a warning message is logged on the Netprobe, all connected Gateways, and Active Console Event Tickers.

For security, you can only set this variable in the start-up environment on the machine running the Netprobe. You cannot configure them as part of the Netprobe on the Gateway.

If you have setTRUSTED_API_HOSTS, the Netprobe checks any connections against the list of hostnames and IP addresses. If an explicit IP address fails to match, then the Netprobe will try a reverse DNS lookup by checking if any hosts in the list match. If the previous check still fails, then the Netprobe will check each host in the list and check the first returned IP address.

This is the equivalent of the advanced Gateway Setup File setting trustedAPIHosts.

The maximum amount of outgoing comms data to store for the whole process. The value is in MB and in the range 25 to 250 inclusive. The default is 60.

The maximum amount of outgoing comms data to store for a single connection. The value is in MB and in the range 5 to 50 inclusive. The default is 30.

The time to cache the result of a DNS lookup (this variable is more used in relation with Gateway, but can be used with Netprobe as well). The value is in seconds and is a positive integer amount. The default is 0, i.e. no flush.

Default value: 20

Default value: 3

Default value: 5

If the Netprobe fails to communicate with the managed Collection Agent after the maximum number of attempts, then the Netprobe stops monitoring the managed Collection Agent.

Default value: 3