Netprobe Command-line Options

Note

The /nopassword option will override this option but ENCODED_PASSWORD will still be set in the registry.

Used in conjunction with /setup. If /setup is not defined, then this option is ignored.

If invoked, the Netprobe runs a discovery executable on the machine it is running on. This executable extracts JSON metadata from its environment, and updates the Netprobe setup file with the metadata through the use of macros.

If you specify a setup URL with the ? character, then the Netprobe appends the JSON metadata as query parameters and pulls the setup file from the URL specified.

When present, the discovery executable runs at Netprobe startup, before the Netprobe reads any setup file, and before it connects to any Gateway.

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

Mandatory: No

Sets the setup file for a self-announcing or floating Netprobe. By default, the full path is <directory of installer>\\setup.netprobe.xml.

If you use the default setup file, then this will be copied into the installation directory (for example, C:\Program Files (x86)\NetprobeNT). This new path then becomes the value of the -setup argument of the Netprobe imagePath registry.

If you specify your own setup file, the file will be used in its respective directory. It will not be copied into the installation directory.

If you specify a remote file (<url>), the Netprobe saves a copy of this in the installation directory as netprobe.setup.xml. This overwrites the existing netprobe.setup.xml file in the installation directory. In this case, any local changes to the netprobe.setup.xml configuration are ignored as the Netprobe retrieves the configuration from the remote file every /setup-interval=<minutes>.

If you specify an invalid file from the <url>, or the <url> becomes inaccessible, then the Netprobe uses the existing netprobe.setup.xml file.

Auto-discovery

When used with /discovery, the Netprobe setup file generates its contents from JSON metadata pulled from its environment by the discovery script.

If you specify a setup URL with the ? character, then the Netprobe appends the JSON metadata as query parameters and pulls the setup file from the URL specified. For more information, see Auto-discovery in Netprobe Overview.

Note

/setup=<url> only supports HTTP links by default. If you need to set up an HTTPS connection, see the /setup-server-verify option. When using /setup= with multiple instances of the Netprobe, check that you install each probe in its own directory. Otherwise, the setup for each probe may interfere with one another. Do not use proxy servers for /setup=<url>. Proxy servers are not supported.

Used in conjunction with /setup.

Defines the time interval before the floating or Self-Announcing Netprobe requests another configuration file and restarts the announcement process. If no new or valid file is discovered, then the Netprobe neither reloads the configuration file nor restarts the configuration process.

If no -setup-interval is defined, the Netprobe makes the request every 360 minutes (or 6 hours), by default.

Feature behavior

By default, this option only works for remote configurations defined through /setup=<url>. However, if used in conjunction with /discovery, then this option works for both /setup=<filename> and <url>.

Auto behavior

When used with /discovery, then this option defines the time interval before the Netprobe reruns the discovery executable to update the JSON metadata. If no updates are discovered from the extracted JSON metadata, then the Netprobe does not reload the Netprobe setup file. For more information, see Auto-discovery in Netprobe Overview.

Used in conjunction with /setup=<url>. This option only takes effect when an HTTPS <url> is specified. Otherwise, this option is ignored.

When this option is invoked, the Netprobe verifies the remote server against the specified Certificate Authority (CA) bundle.

Used in conjunction with /secure; sets the SSL certificate file which is used to allow the probe to run in secure mode (when accepting incoming connections) Default: <directory of installer>\\cert.netprobe.pem

If the default SSL certificate file is not used, then the file specified will be used in situ. It will not be copied into the installation destination.

If the default SSL certificate file is used then it will be copied to the installation destination (for example, C:\\Program Files (x86)\\NetprobeNT) and this new path will be set as the value of -ssl-certificate argument of Netprobe’s imagePath in registry.

Used in conjunction with /secure; sets the SSL certificate chain file used by the Netprobe to check the certificate of the Gateway when a connection is made. Default: *<directory of installer>\\cert-chain.netprobe.pem*

If the default SSL certificate chain file is not used, then the file specified will be used in situ. It will not be copied into the installation destination. If the default SSL certificate chain file is used then it will be copied to the installation destination (for example, C:\\Program Files (x86)\\NetprobeNT) and this new path will be set as the value of *-ssl-certificate-chain* argument of Netprobe’s imagePath in registry.

Used in conjunction with /secure; used to explicitly define the signed SSL server private key in PEM format.

If this option is not specified, but the certificate is, the Netprobe will look for the private key in the same file as the server certificate.

• 1
• 1.0
• 1.1
• 1.2
• 1.3

-version

-ver

-v

• schema — extracts the Gateway Setup File schema embedded in the Netprobe binary.
• npschema — extracts the Netprobe Setup File schema embedded in the Netprobe binary.

Used in conjunction with -setup. If -setup is not defined, then this option is ignored.

If invoked, the Netprobe runs a discovery executable on the machine it is running on. This executable extracts JSON metadata from its environment, and updates the Netprobe setup file with the metadata through the use of macros.

If you specify a setup URL with the ? character, then the Netprobe appends the JSON metadata as query parameters and pulls the setup file from the URL specified. When present, the discovery executable runs at Netprobe startup, before the Netprobe reads any setup file, and before it connects to any Gateway.

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

Mandatory: No

-setup

-setup <filename>

-setup <url>

Used when running the Netprobe in Floating or Self-Announcing mode. Specifies the Netprobe Setup File to use.

The Netprobe Setup File can be specified as a local file (<filename>) or a remote file (<url>).

If no <filename> or <url> is specified, then the Netprobe defaults to the netprobe.setup.xml file in the current working directory. The Netprobe Setup File needs to specify the connection details of one or more Gateways.

If you specify a remote file (<url>), the Netprobe saves a copy of this in the current working directory as netprobe.setup.xml. This overwrites the default Netprobe configuration. In this case, any local changes to the netprobe.setup.xml configuration are ignored as the Netprobe retrieves the configuration from the remote file every -setup-interval <minutes>.

If you specify an invalid file from the <url>, or the <url> becomes inaccessible, then the Netprobe uses the default configuration.

Auto-discovery

When used with -discovery, the Netprobe setup file generates its contents from JSON metadata pulled from its environment by the discovery script.

If you specify a setup URL with the ? character, then the Netprobe appends the JSON metadata as query parameters and pulls the setup file from the URL specified.

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

Note

-setup <url> only supports HTTP links by default. If you need to set up an HTTPS connection, see the -setup-server-verify option. When using -setup <url> with multiple instances of the Netprobe, check that you run each probe in its own directory. Otherwise, the setup for each probe may interfere with one another. Do not use proxy servers for -setup <url>. Proxy servers are not supported. The -setup <url> option is not supported for IBM AIX platforms.

Used in conjunction with -setup.

Defines the time interval before the floating or Self-Announcing Netprobe requests another configuration file and restarts the announcement process. If no new or valid file is discovered, then the Netprobe neither reloads the configuration file nor restarts the configuration process.

If no -setup-interval is defined, the Netprobe makes the request every 360 minutes (or 6 hours), by default.

Feature behavior

By default, this option only works for remote configurations defined through -setup <url>. However, if used in conjunction with -discovery, then this option works for both -setup <filename> and <url>.

Auto-discovery

When used with -discovery, then this option defines the time interval before the Netprobe reruns the discovery executable to update the JSON metadata. If no updates are discovered from the extracted JSON metadata, then the Netprobe does not reload the Netprobe setup file.

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

Note

For IBM AIX platforms, this option works when used in conjunction with -discovery and -setup <file path>.

Used in conjunction with -setup <url>. This option only takes effect when an HTTPS <url> is specified. Otherwise, this option is ignored.

When this option is invoked, the Netprobe verifies the remote server on the -setup <url> against the specified Certificate Authority (CA) bundle.

You can specify a CA bundle on the <file> argument in PEM format.

If no <file> is specified, then the Netprobe verifies the remote server against the operating system’s Certificate Authority (CA) bundle. In this case, the required certificates must be installed in the appropriate certificate stores.

Note

• On Windows, the <file> argument is required.
• On Linux, the Netprobe searches for the default CA bundle at /etc/pki/tls/certs/ca-bundle.crt. However, in Ubuntu and SLES platforms, the default CA bundle is not located at this path. For these platforms, you can either specify a CA bundle file for this option or create a symbolic link at /etc/pki/tls/certs/ca-bundle.crt to the platform’s default CA bundle.
  • For Ubuntu: The default CA bundle is at /etc/ssl/certs/ca-certificates.crt.
  • For SLES: The default CA bundle is at /var/lib/ca-certificates/ca-bundle.pem.
• On IBM AIX, this option is not supported.

Test utility for Market Data Monitor Lua script prior to deployment.

Example: $./netprobe.linux-mdmtesttest.luaparam1param2

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. For more information, see Disable listening in Manage Self-Announcing Netprobes.

This is the file that contains the signed SSL server private key in PEM format.

If this is option not specified, but the certificate is, then the Netprobe will look for the private key in the same file as the server certificate.

This forces the Netprobe to require certain components connecting to the Netprobe port to provide a valid SSL certificate.

If no certificate is provided, or the certificate cannot be vaildated using the certificate authority provided by the -ssl-certificate-chain option, the connection will be rejected. The connection type of the connections to check must be provided.

This command line option only supports the emf2 argument, which covers all Geneos components connecting using the Geneos EMF2 protocol.

If this option is present, the Netprobe will listen on a secure port rather than an insecure port.

If -secure is specified, then an SSL server certificate and an server private key also need to be specified.

• QM — queue manager, e.g. qm.test
• MQSERVER — server connection string, e.g. CHAN/TCP/host(port)
• CHANTAB — full path to the channel table file, e.g. /var/mqm/AMQCLCHL.TAB
• KEYREPO — full path to SSL key repository, e.g. /var/mqm/ssl/key(.kdb)
• CIPHER — SSL cipher specification, e.g.TRIPLE_DES_SHA_US

• 1
• 1.0
• 1.1
• 1.2
• 1.3

To set the available TLS ciphers use the -openssl-cipher command line option, replacing `` with a comma separated list of ciphers.

For more information, see TLS ciphers in Secure Communications.

Specifies <path> of the JVM library to use.

If this option is invoked, the Netprobe does not attempt to locate the library in the PATH or LD_LIBRARY_PATH environment variable. In Windows, the JVM_LIBPATH registry key is ignored.

Example value: -jvm-libpath /usr/java/jdk/jre/lib/amd64/server/libjvm.so

Note

The Npcap packet capture library needs to be installed on the host. If Npcap is not installed using WinPcap API-compatible mode, then the Npcap installation directory must be added in the PATH environment variable or the DLL_PATH registry variable.