If you are currently using version 5.x.x, we advise you to upgrade to the latest version before the EOL date. You can find the latest documentation here.
Netprobe Command-line Options
Overview
Command-line options can either be passed to the Netprobe installer on , or directly to the Netprobe binary.
Installer command-line options
The installer command line options are available only to
platforms.Option | Use |
---|---|
/netport
|
Sets the Netprobe listening port.
Default: 7036 |
/servicename=<servicename>
|
Sets the Netprobe service name.
Default: NetprobeNT |
/nopassword
|
Allows commands to run on the Netprobe without any prompting for a password. For more information, see Set passwords on Netprobe commands. |
/pass=<password>
|
Sets a Netprobe password. |
/listenip
|
Sets a specific IP address where the Netprobe will listen to incoming connections. |
/listenoverride
|
Used in conjunction with /listenip , overrides the previous value of /listenip if it exists. |
/discovery=<full path to file>
|
Used in conjunction with 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 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 Introduction to Netprobe. Mandatory: No |
/setup=<full path or URL to file>
|
Sets the setup file for a self-announcing or floating Netprobe. By default, the full path is If you use the default setup file, then this will be copied into the installation directory (for example, 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 ( If you specify an invalid file from the Auto-discovery When used with If you specify a setup URL with the For more information, see Auto-discovery in Introduction to Netprobe. Note: |
/setup-interval=<minutes>
|
Used in conjunction with 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 Feature behaviour By default, this option only works for remote configurations defined through Auto-discovery When used with For more information, see Auto-discovery in Introduction to Netprobe. |
/setup-server-verify <file>
|
Used in conjunction with When this option is invoked, the Netprobe verifies the remote server against the specified Certificate Authority (CA) bundle. |
/ssl-certificate=<full path to file>
|
Sets the SSL certificate file which is used to allow the probe to run in secure mode (when accepting incoming connections)
Default: 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, |
/ssl-certificate-chain=<filename>
|
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. |
/dir=<install\_dir>
|
Sets the Netprobe installation path. |
/log=<filename>
|
Sets the Netprobe log filename. |
/silent
|
Runs the install with no user interaction, but you can see the installation progress. |
/verysilent
|
Does the same as /silent but it does not show the installer files being extracted. |
/require-ssl-certificate-for
|
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. Currently, this does not require any additional parameter as only the connection type EMF2 is supported. |
The /nopassword
option will override /pass
option
but ENCODED_PASSWORD
will still be set in the
registry.
To set up a Self-Announcing or Floating Netprobe from the installer wizard, check the "Install as Self-Announcing or Floating Netprobe" checkbox from the "Configure Self-Announcing or Floating Netprobe" screen. Select a configuration file from that screen.
You can also specify the Self-Announcing or Floating
Netprobe configuration file through installer command-line
switch. To do this, start a new Administrator command-line window and run geneos-netprobe-<version>.windows-<platform>.setup.exe.windows-x64.setup.exe
/setup=<setup xml filename>, where <setup xml
filename> specifies the full path to the
Self-Announcing or Floating Netprobe configuration
file:
geneos-netprobe-*<version>*.windows-<platform>.setup.exeExample: geneos-netprobe-*<version>*.windows-<platform>.setup.exe.
To setup a secure Netprobe from the installer wizard, check the "Run probe in Secure Mode" checkbox from the "Configure Netprobe Secure Connections" screen. Select a PEM file that contains both the secure key and the secure certificate that the probe will use. This can also be done on the command line by using the /ssl-certificate flag. The flag followed by the name of the PEM file to use.
The certificate chain that is used to verify the certificates presented to the Netprobe can also be set either by using the wizard and setting the file on the "Configure Netprobe Secure Chain" page, or by using the /ssl-certificate-chain command flag. In both cases a file containing the certificates with which the presented certificates have been signed must be provided.
If you're doing a silent mode install using either /silent or /verysilent option then the /setup= switch should be used if a the probe is to run as a Self-Announcing or Floating Netprobe. The /ssl-certificate= flag should be used if the Netprobe is to run in a secure mode and only accept secure (TLS) connections from the gateway. The /ssl-certificate-chain= switch should be used if the Netprobe is to validate the gateway certificates prior to allowing the gateway to connect to the probe. If any of the files specified do not exist then the installer will fail silently and an 'Install Failed' line will be logged in the setup log. You can specify the log file with the /log=<log file> switch in the installer.
On completion, the Netprobe will have been installed and started running as a service. The relevant registry settings will also have been set up.
Note: If the Windows Win Apps Plug-in is to be run on a Windows 2008 Server, then it is necessary to alter the properties of the service to "Allow service to interact with desktop". For more information, see Windows Win Apps.
Binary command-line options
The binary command line options are applicable to all platforms, unless otherwise stated.
Binary command line option | Description |
---|---|
-help
|
Displays a list of command line options and exits. |
|
Displays version information and exits. |
-port
|
Sets the listening port for the Gateway connection. |
-nolog
|
Ignores any setting from the LOG_FILENAME variable
and logs to the terminal instead. |
-extract <key> <filename>
|
Extracts data embedded in the
binary, writing it to the There are two
supported values for
|
-noschema
|
If invoked, the Netprobe does not publish the schema to the Gateway. |
-discovery <file path>
|
Used in conjunction with 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 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 Introduction to Netprobe. Mandatory: No |
|
Used when running the Netprobe in Floating or Self-Announcing mode. Specifies the Netprobe Setup File to use.
If no If you specify a remote file ( If you specify an invalid file from the Auto-discovery When used with If you specify a setup URL with the For more information, see Auto-discovery in Introduction to Netprobe. Note: |
-setup-interval <minutes>
|
Used in conjunction with 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 Feature behaviour By default, this option only works for remote configurations defined through Auto-discovery When used with For more information, see Auto-discovery in Introduction to Netprobe. Note: |
-setup-server-verify <file>
|
Used in conjunction with When this option is invoked, the Netprobe verifies the remote server on the You can specify a CA bundle on the If no Note: On |
-mdmtest <lua_script> [params]
|
Test utility for Market Data Monitor Lua script prior to deployment. Example:
|
-listenip
|
Sets a specific IP address where the Netprobe will listen to incoming connections.
|
-ssl-certificate
|
This is the file that contains the signed SSL server certificate in PEM format. |
-ssl-certificate-key
|
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. |
-ssl-certificate-chain
|
This is the file that contains the trusted certificate authority. |
-require-ssl-certificate-for
|
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 This command line option only supports the following argument:
|
-secure
|
If this option is present, the Netprobe will listen on a secure port rather than an insecure port. If |
-nopassword
|
Run commands on the Netprobe's host. For more information, see Set passwords on Netprobe commands. |
-mq QM=<qm_name> MQSERVER=<conn_string> CHANTAB=<chan_table> KEYREPO=<ssl_keyrepo> CIPHER=<cipher_spec>
|
Test MQ connection
Example value: |
-minTLSversion
|
Specifies the minimum TLS version. The accepted values are:
|
-openssl-cipher <ciphers>
|
To set the available TLS ciphers use the For more information, see TLS ciphers in Secure Communications. |
-json2XML <filename>
|
Converts JSON document specified by Applicable to Windows platforms only. |
-jvm-libpath <path>
|
Specifies If this option is invoked, the Netprobe does not attempt to locate the library in the Example value: Applicable to Windows platforms only. |
-java-home <path>
|
Specifies the Applicable to Windows platforms only. |
-perf
|
Show available performance monitor counters. Applicable to Windows platforms only. |
-cmd
|
Run in the foreground, rather than as a service. Applicable to Windows platforms only. |
-install
|
Installs the probe as a service. Applicable to Windows platforms only. |
-uninstall
|
Uninstalls the probe as a service. Applicable to Windows platforms only. |
-showcpus
|
Shows detected CPU information for this machine. Applicable to Windows platforms only. |
-disable-core-dump
|
Disables creation of core dump files. Applicable to Windows platforms only. |
-ifconfig, -if
|
Lists down the NICs present in the Windows machine. This should be used in configuring X-plugins send / recv interfaces. Applicable to Windows platforms only. |
-perfdebug
|
Dumps performance counter data into a file
(i.e. Applicable to Windows platforms only. |
-json2XML <filename>
|
Converts JSON document specified by Applicable to Windows platforms only. |