Nxtcfg is a small console application that reads and modifies the configuration parameters of Collector. Run Nxtcfg with administrator privileges.
By default, the Nxtcfg tool is installed along with Collector when installing the Collector MSI. Here is the absolute file path:
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.
Start the Collector.
Stop the Collector.
Restart the Collector.
Get the value of a particular configuration parameter from the Collector. See the table in the next section for the list of possible parameters.
Set the value of one or more configuration parameters of the Collector. See the table in the next section for the list of possible parameters.
List all the configuration parameters of the Collector with their current values.
Dump all the configuration parameters of the Collector and their corresponding values to a file.
Microsoft Windows [Version 10.0.19042.1766] (c) Microsoft Corporation. All rights reserved. C:\WINDOWS\system32>nxtcfg.exe /l + Copyright (C) 2004 - 2019 Nexthink S.A. All rights reserved. + nxtcfg.exe - Changes the configuration of the Nexthink Collector. + version 220.127.116.11 ip=docs.nexthink.com (::1) udp_port=2001 tcp_port=8443 tag=0 string_tag="default_string_tag" cgpi=240 logmode=2 logsize=1 dwef=0 mss=1224 wme=1 wm_domains=not set dsps=1 iops=1 prefer_ipv6=0 pkg_interval=1 custom_shells=0 customer_key=-----BEGIN CUSTOMER KEY-----docs [truncated] docs-----END CUSTOMER KEY----- root_ca=-----BEGIN CERTIFICATE-----docs [truncated] docs==-----END CERTIFICATE----- clt_state=functioning_properly traffic_status=317 packets sent (341834 bytes) tcp_status=[26.08.2022 09:11:28.439] [INFO] Connected execution_policy=signed_trusted_or_nexthink printing=disable assignment_status=assigned engage=enable_except_on_server_os use_assignment=enable data_over_tcp=enable proxy_address=not set proxy_port=not set proxy_pac_address=not set mtls_fingerprint=not set mtls_issuer_common_name=not set mtls_subject_common_name=not set install_browser_extension=not set nxtcfg.exe completed successfully.
The modification of some of the parameters requires a restart of Collector for all the changes 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 reboot or component restart is required.
Collector restart or device reboot is required.
Fully qualified domain name (FQDN) of your Nexhtink instance.
Port number for UDP communication with your Nexhtink instance.
[1 - 65535]
Port number for TCP communication with your Nexhtink instance.
[1024 - 65535]
Optional integer number to identify the installation.
[0 - 2147483647]
Optional label to identify the installation.
any string (max 2048 chars)
The CrashGuard protection interval value is the time interval since boot (in minutes) after which a dirty reboot, a spontaneous system restart, does not increase the CrashGuard.
[0 - 2]
Maximum size of log file when logging is enabled. Logs are rotated after the maximum is reached.
[1 - 512] MB
Disable or enable print monitoring function.
[disable - enable]
Disable (1) or enable (0) SMB print monitoring subfunction (requires printing enabled).
[0 - 1]
Enable (1) or disable (0) IOPS monitoring functionality.
[0 - 1]
When set, Collector does not report when an application freezes or stops responding.
[0 - 1]
Maximum size, in bytes, of the UDP packets sent from the Collector to the Nexthink instance.
[1000 - 16384] B
Period, in hours, in which Collector checks for new installed packages and updates and reports them:
[0 - 24]
When set, Collector reports Web and Cloud data.
[0 - 1]
List of domains for which to report the URL of web requests.
When set, the Collector prefers IPv6 to communicate with the Nexthink instance when the FQDNs resolves to both IPv6 and IPv4 addresses.
[0 - 1]
When set, enable Collector to report user logon events in environments where Explorer is not the default shell. For example, certain embedded (kiosk mode) or virtualized environments.
[0 - 1]
The security policy to apply when executing scripts of remote actions.
The customer key of the Nexthink instance.
Path to text file with the cryptographic key.
The root certificate of the Nexthink instance.
Path to text file with the root certificate.
The status of the assignment of the Collector.
Instruct the Collector whether to use or not use the assignment service.
Yes (only when enabling)
Activation of the features to engage with the employees.
Send the Collector data over TCP.
URL of the PAC file to automatically configure the proxy settings.
FQDN of the proxy for manual configuration of proxy settings.
Port number where the proxy is listening for manual configuration of proxy settings.
Nxtcfg in remote actions
Because Collector communicates with the Nexthink instance when running remote actions, it is not recommended to change any of the configuration parameters of Collector from a remote action. Thus, refrain from modifying any of the following configuration parameters when running
nxtcfg.exe within a remote action:
For the same reason, do not stop or restart Collector with
nxtcfg.exe using a remote action. Directly stopping or restarting Collector abruptly ends the communication between Collector and the Nexthink instance, resulting in Collector losing its state in respect to the remote action. Once Collector is up again, it starts the execution of the remote action from the beginning, potentially creating an infinite loop.
Instead, if you need to modify some Collector settings from a remote action that requires a restart, use the following code in the script of the remote action:
To stop Collector:
Stop-Service -Name "Nexthink Service" -Force Stop-Service -Name "nxtrdrv5" -Force Stop-Service -Name "nxtrdrv" -Force
To start Collector:
Start-Service -Name "nxtrdrv" Start-Service -Name "nxtrdrv5" Start-Service -Name "Nexthink Service"
Setting the customer key and root certificate
Collector uses the customer key and root certificate to validate the identity of the Nexthink instance and securely communicate with it via TLS. If any of these security parameters change you must change the configuration in your Collectors accordingly.
root_ca are special in the sense that they do not admit a direct value as an argument, but a path to a text file holding the actual value of the customer key or the default root certificate, respectively.
To set the customer key and root certificate, type in the following command:
nxtcfg.exe /s customer_key="C:\Nexthink-customer-key.txt" root_ca="C:\Nexthink-root-ca.txt"
The instruction above assumes that you placed the files in the root directory of your C: drive
When listing the
root_ca parameters with the /l option of Nxtcfg, neither the full customer key nor the full root certificate is displayed. 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 the other parameters readable.