Netprobe variables

Overview

The following variables fine-tune Netprobe operation or override the defaults. On non-Windows platforms these should be set as environment variables in the shell from which the Netprobe is launched. On Windows they should be set in the registry - see Setting variables for Netprobe on Windows platforms.

Where these variables are described as an equivalent of an advanced Gateway Setup File setting, more details on the Gateway Setup File setting can be found in Probes.

For Normal Netprobes, see Probe settings - Advanced tab.

For Floating Netprobes, see Floating Probe settings - Advanced tab

For Self-Announcing Netprobes, these settings cannot be defined in the Gateway Setup File - they have to be set by using the variable on the Netprobe.

Variables

Name Use
DISCOVERY_DEBUG

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

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

DLL_PATH

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.

LOG_FILENAME

The Netprobe error and log file. If the filename is not defined, the errors and messages are sent to standard out. 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 '-nolog' command line parameter.
  • If the Netprobe software has been installed on a shared drive and is being run on more than one machine at thesame time, see Using a Shared Drive for important information regarding the setting of this variable.
  • A full path can be specified in this variable if the user wishes 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.

LOG_TIME_FORMAT

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>
MAX_LOG_FILE_SIZE_MB The Netprobe error and log file can be setup to roll over to a new log file when it gets bigger than MAX_LOG_FILE_SIZE_MB. The maximum value that can be set is 4096Mb and the minimum is 1Mb. If the value is outside of these ranges or the input is invalid, then the default of 10Mb will be used. This is the equivalent of the advanced Gateway Setup File setting maxLogFileSize.
LOG_ARCHIVE_SCRIPT The log file generated by Netprobe will grow up to 1 Mb. 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, the UNIX script defined by the environment variable will be called after the log file has been renamed. The script is passed 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.
NET_PORT The TCP/IP port number that the Gateway uses to connect to Netprobes. To avoid confusion it is recommended that this setting is the same for all the Gateways and Netprobes. The default port number is 7036.
ENCODED_PASSWORD
ALLOW_ENCODED_PASSWORD_DOWNLOAD
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.
TRUSTED_GATEWAY_HOSTS
TRUSTED_GATEWAY_NAMES

If set, contains a nominated list of trusted Gateway hosts that the Netprobe can connect to. The Netprobe will accept connections only from the Gateways listed.

TRUSTED_GATEWAY_HOSTS may contain a host alias as defined in /etc/hosts file. If TRUSTED_GATEWAY_HOSTS is set to +, then any Gateway is trusted—this is equivalent to not setting the TRUSTED_GATEWAY_HOSTS variable.

Non-trusted hosts attempting to connect will cause a warning message to be logged on the Netprobe and to all connected Gatewayand Active Console Event Tickers.

For security, you can only set the TRUSTED_GATEWAY_HOSTS setting on the machine running the Netprobe. You cannot set it as part of the probe configuration on the Gateway.

A similar setting, TRUSTED_GATEWAY_NAMES, can be configured to restrict Gateways connecting to Netprobe in the same manner as TRUSTED_GATEWAY_HOSTS. This setting checks the Gateway name rather than the host.

TRUSTED_HTTP_HOSTS

If set, contains a nominated list of trusted HTTP hosts that the Netprobe can connect to. The Netprobe will accept connections only from the hosts listed.

TRUSTED_HTTP_HOSTS may contain a host alias as defined in /etc/hosts file. If TRUSTED_HTTP_HOSTS is set to +, then any HTTP host is trusted—this is equivalent to not setting the TRUSTED_HTTP_HOSTS variable.

Non-trusted hosts attempting to connect via HTTP will cause a warning message to be logged on the Netprobe and to all connected Gateway and Active Console Event Tickers.

TRUSTED_DEBUG_HOSTS

If set, contains a nominated list of trusted HTTP debug hosts that the Netprobe can connect to. The Netprobe will accept connections only from the debug hosts listed.

TRUSTED_DEBUG_HOSTS may contain a host alias as defined in /etc/hosts file. If TRUSTED_DEBUG_HOSTS is set to +, then any HTTP host is trusted. By default, the trusted debug host is 127.0.0.1. This applies even if TRUSTED_DEBUG_HOSTS is not set.

Non-trusted hosts attempting to connect via HTTP will cause a warning message to be logged on the Netprobe. For example:

WARN: ORB Non-trusted host itrslp003 rejected. Trusting only (127.0.0.1) for HTTP Debug components.
PERMISSIONS
This variable can be used to control which RMS commands can be executed on the Netprobe. Possible values are:
  • 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 settingpermissions.

TRUSTED_API_HOSTS Specifies an optional list of hostnames which are permitted to the API plug-in on this Netprobe. If specified, hosts not in this list will be rejected. If unspecified, all hosts can connect to the API plug-in. For more information, see XML-RPC Instrumentation API - Technical Reference. This is the equivalent of the advanced Gateway Setup File setting trustedAPIHosts.
PROCESS_LIST_COMMAND A probe-wide setting which affects all PROCESSES plug-ins for legacy Netprobes. This setting specifies a command to obtain process details for a legacy Netprobe. The default varies according to target operating system, but is typically "ps -ef". This is the equivalent of the advanced Gateway Setup File setting processListCommand.
WIDE_ PROCESS_LIST_COMMAND A probe-wide setting which affects all PROCESSES plug-ins running on a Solaris Netprobe. This setting specifies the command to obtain the full process name for processes with names longer than 75 characters. The default is "/usr/ucb/ps -axww". This is the equivalent of the advanced Gateway Setup File setting wideProcessListCommand.
CACHE_PROCESS_NAMES A Boolean value specifying whether to cache process names on Linux. This should be set to "false" if process names can change during execution. The default is "true". This is the equivalent of the advanced Gateway Setup File setting cacheProcessNames.
HEARTBEAT_INTERVAL When Netprobe does not receive any communication from a connected component within this number of seconds, it sends a heartbeat message to the component. Netprobe will then expect a reply within the number of seconds specified by the CONNECT_WAIT setting (see below). If the reply is not received within this time, the connection is terminated and re-established. The value supplied is in seconds, within the range 1 to 300, and defaults to 70. This is the equivalent of the advanced Gateway Setup File setting heartbeatInterval.
CONNECT_WAIT The time to wait for a connection to be established. The value supplied is in seconds, within the range 1 to 300, and defaults to 15. This is the equivalent of the advanced Gateway Setup File setting connectWait.
MAX_DATABASE_CONNECTIONS This sets the maximum amount of connections that a Netprobe can make to any database e.g. if managed_entity_1 belonging to probe_1 uses 3 SQL-TOOLKIT plug-ins, 1 Sybase plug-in and 1 Oracle plug-in and managed_entity_2 belonging to probe_1 uses the same, then they will have used 10 database connections in total. If probe_1 is using the default value then this means no more database connections could be made. The default is 10. This is the equivalent of the advanced Gateway Setup File setting maxDatabaseConnections.
PUBLISH_SCHEMA Set this variable to "false" to disable publishing of the schema file. This is the equivalent of starting the Netprobe with the -noschema Netprobe Command-line Options.
REJECT_TIMEOUT_INTERVAL Time for which a "bad" connection from a Gateway should be blocked before allowing it to retry.
MAIN_BUFFER_MAX 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.
CONNECTION_BUFFER_MAX 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.
FLUSH_DNS_PERIOD 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.
DISABLE_CORE_DUMP Set this variable to "true" to disable the creation of core dump files if Netprobe crashes. The default is "false".
LISTEN_IP Sets a specific IP address where the Netprobe will listen to incoming connections.

This argument can be used to force Self-Announcing Netprobes not to listen for incoming connections. See Disable listening in Manage Self-Announcing Netprobes.
CA_HEALTHCHECK_INTERVAL

Time in seconds between pings from the Netprobe to a managed Collection Agent.

This only applies to a managed Collection Agent not running in detached mode. For more information, see Run Collection Agent with Netprobe.

Default value: 20

CA_MAX_HEALTHCHECK_ATTEMPTS

Maximum number of attempts that the Netprobe makes to contact a managed Collection Agent.

This only applies to a managed Collection Agent not running in detached mode. For more information, see Run Collection Agent with Netprobe.

Default value: 3

CA_HEALTHCHECK_TIMEOUT

Time in seconds that the Netprobe waits for a response from the Collection Agent during a health check.

This only applies to a managed Collection Agent not running in detached mode. For more information, see Run Collection Agent with Netprobe.

Default value: 5

CA_MAX_RESTARTS

Maximum number of attempts that the Netprobe makes to restart an unresponsive managed Collection Agent.

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.

This only applies to a managed Collection Agent not running in detached mode. For more information, see Run Collection Agent with Netprobe.

Default value: 3

   

Note: There are a number of other variables which can be set for debug or diagnostic purposes. These should only be used when requested or advised to do so by ITRS. These include DEBUG, GENERAL_DEBUG, GL_DEBUG, ISFS_SAMPLE_DEBUG, FKM_DEBUG, PROCESS_SAMPLE_DEBUG, SERVICE_SAMPLE_DEBUG, PROBE_MEM_TIME_INTERVAL, MAX_MEM_SIZE, DISABLE_MEM_PROTECTION and LEAK_MEMORY.

Setting variables for Netprobe on Windows platforms

For Windows platforms, the Netprobe does not read the above variables from the environment variables. Instead, these values need to be set in the registry. The Windows Netprobe installer will have created a set of registry keys under HKEY_LOCAL_MACHINE\SOFTWARE\NetAgent\NetprobeNT.

If a non-default service name was specified when the Netprobe was installed, then that name replaces NetprobeNT in this key name.

Use the Registry Editor on Windows to edit the values, or add new name-value pairs in this set of registry keys.

Alternatively, it is possible to get or set Netprobe registry keys using the utilities na_getenv.exe and na_setenv.exe, which are installed as part of the Windows Netprobe package.

Utility Use Example
na_getenv.exe Extracts the value of a Netprobe registry key Using a default Netprobe installation (i.e. where the service name is "NetprobeNT"), the command na_getenv.exe NetprobeNT NET_PORT will return the default port value of 7036.
na_setenv.exe Sets the value of a Netprobe registry key Again using a default Netprobe installation, the command na_setenv.exe NetprobeNT NET_PORT 12345 will change the listen port for the service NetprobeNT to port 12345.

For a complete list of command-line options, see Netprobe Command-line Options.

Location of Windows registry files for Netprobe

Go to the Registry Editor to locate the registry path of the Netprobe. The default registry path of Netprobe is:

HKEY_LOCAL_MACHINE \SOFTWARE : \system32\config\software
OS Bit Platform Registry Path
64-bit HKEY_LOCAL_MACHINE \SOFTWARE\NetAgent\