Nxtcfg - Collector configuration tool
Nxtcfg - Collector configuration tool
Nxtcfg is a small console application that allows to read and modify the configuration parameters of the Collector. Ensure that you run Nxtcfg with administrator privileges.
By default, the Nxtcfg tool is installed along with the Collector when installing the Collector MSI. Once the Collector is installed, the Nxtcfg tool is located under C:\Windows\System32\nxtcfg.exe.
The Collector MSI version used determines the nxtcfg version installed (Windows 32-bit or 64-bit system).
If not required, add the option CFG_INSTALL=0 to the MSI command line, when installing the Collector.
|/disable||Turn off the Nexthink Collector (the driver is kept in memory in idle state).||nxtcfg.exe /disable|
|/enable||Turn on the Nexthink Collector.||nxtcfg.exe /enable|
|/g||Get the value of a particular configuration parameter from the Collector.||nxtcfg.exe /g ip|
|/s||Set the value of one or more configuration parameters of the Collector.||nxtcfg.exe /s ip=192.168.0.1 udp_port=999|
|/l||List all the configuration parameters of the Collector with their current values.||nxtcfg.exe /l|
|/d||Dump all the configuration parameters of the Collector and their corresponding values to a file.||nxtcfg.exe /d C:\temp\collector.cfg|
The modification of some of the parameters requires to restart the Collector for the change to take effect. Rebooting the device forcefully restarts all Collector components as well. For each parameter, this is specified by the values in the column Restart required of the parameters table:
- No: No reboot or component restart required.
- Coord: Coordinator restart or reboot required. To restart the Coordinator from the device, open a command window as administrator and type in:
net stop "Nexthink Coordinator"
- Wait for the Coordinator to stop and then type in:
net start "Nexthink Coordinator"
- Driver: Driver restart or reboot required. To restart the Driver from the device, open a command window as administrator and type in:
net stop "Nexthink Collector Driver"
- Confirm the operation and wait for all the dependent Collector services to stop.
- Start the Collector Service (note the difference) to restart all Collector components, including the driver:
net start "Nexthink Collector Service"
|Parameter||Description||Default value||Range||Restart required|
|ip||IP address or DNS name of the Engine.||-||-||No|
|udp_port||UDP port number where the Engine is listening.||-||[1 - 65535]||No|
|tcp_port||TCP port number where the Engine is listening.||-||[1024 - 65535]||Coord|
|tag||Optional number to identify the installation.||0||[0 - 2147483647]||No|
|cgpi||CrashGuard Protection Interval Value. It is the time interval since boot (in minutes) after which a dirty reboot does not increase the CrashGuard.||0 min||-||Driver|
|logmode|| Logging mode
||0||[0 - 2]||No|
|logsize||Maximum size of log file when logging is enabled. Logs are rotated after the maximum is reached.||32 MB||[1 - 512] MB||Driver|
|dsps||Disable (1) or enable (0) SMB print monitoring functionality.||1||[0 - 1]||Driver|
|iops||Enable (1) or disable (0) IOPS monitoring functionality.||0||[0 - 1]||Driver|
|dwef||When set, the Collector does not report application freezes nor hungs.||0||[0 - 1]||Driver|
|mss||Maximum size, in bytes, of the UDP packets sent from the Collector to the Engine.||1224 B||[1000 - 16384] B||Driver|
|pkg_interval||Period, in hours, in which the Collector checks for new installed packages and updates.||1||[1 - 24]||Driver|
|wme||When set, the Collector reports Web and Cloud data.||1||[0 - 1]||Driver|
|wm_domains||List of domains for which to report the URL of web requests.||-||Comma separated domain names.||No|
|prefer_ipv6||When set, the Collector prefers IPv6 to communicate with the Engine when the name of the Engine resolves to both IPv6 and IPv4 addresses.||0||[0 - 1]||No|
|customer_key||The Customer Key of the master Appliance.||-||Path to text file with cryptographic key.||Driver|
|root_ca||The Root Certificate of the master Appliance.||-||Path to text file with root certificate.||Driver|
Setting the Customer Key and Root Certificate
The Collector uses the Customer Key and Root Certificate to validate the identity of the slave Appliance (Engine) and securily communicate with it via TLS. If any of these security parameters change in the Appliance (e.g. moving from pre-production to production environment), you must change the configuration in your Collectors accordingly.
The parameters customer_key and root_ca are special in the sense that they do not admit a direct value as argument, but a path to a text file holding the actual value of the Customer Key or the Root Certificate, respectively. To download the Customer Key and Root Certificate from the master Appliance, follow the same method described for installing the Collector:
- Log in to the Web Console of the master Appliance as admin.
- Select the Appliance tab at the top of the Web Console.
- Click Collector security in the left-hand side menu.
- Click the buttons DOWNLOAD CUSTOMER KEY and DOWNLOAD ROOT CERTIFICATE to download, respectively, the text files holding the Customer Key and Root Certificate of the Appliance.
To set the Customer Key and Root Certificate downloaded from the master Appliance, type in the following (assuming that you placed the downloaded files in the root directory of your C: drive):
nxtcfg.exe /s customer_key="C:\Nexthink-customer-key.txt" root_ca="C:\Nexthink-root-ca.txt"
When listing the customer_key and root_ca parameters with the /l option of Nxtcfg, neither the full Customer Key nor the full Root Certificate are displayed. Instead, only the first few characters of both the configured key and certificate are shown. These characters are usually enough to identify the key or the certificate, while keeping the list of Nxtcfg parameters readable.
If you need help or assistance, please contact your Nexthink Certified Partner.