Collector MSI parameters reference table
Last updated
Last updated
| Parameter name | Default value | Description |
|---|---|---|
| Parameter name | Default value | Description |
|---|---|---|
In unattended execution mode, all choices are silently accepted. For example, if the parameter REBOOT is set to Force, the computer automatically reboots after MSI package installation.
Always specify MSI parameter names in capital letters. MSI parameters with lowercase letters in an MST are considered private properties. This means you cannot modify them from the CLI.
| Parameter name | Default value | Description |
|---|---|---|
| Parameter name | Default value | Comment |
|---|---|---|
CRD_ROOT_CA
–
Do not use this feature when using the Nexthink cloud platform.
DRV_PORT
–
Do not use this feature when using the Nexthink cloud platform.
CRD_KEY
–
Customer key of the Nexthink instance.
CRD_PORT
443
Nexthink instance port number for the TCP channel.
DATA_OVER_TCP
enable
Send end-user data over the TCP channel of Collector.
Values:
disable
enable
DRV_IP
–
Fully Qualified Domain Name (FQDN) of the Nexthink instance.
ANONYMIZE_USERNAME
cleartext
Controls the Collector level anonymization feature to hash the user name.
Values:
cleartext
hashed
no_import
ANONYMIZE_WIFI_NETWORK
enable
APP_START_TIME_WHITELIST
chrome.exe,firefox.exe,iexplorer.exe, winword.exe,excel.exe,powerpnt.exe, outlook.exe,onenote.exe,onenoteim.exe, onenotem.exe,lync.exe,zoom.exe
The list of applications for which the startup duration is measured.
CFG_INSTALL
1
Install the Nxtcfg tool to change the Collector configuration from the Command Line Interface (CLI).
Values:
0 – Do not install
1 – Install
CONNECTIONS_REPORTING
enable
Enable or disable the connections data reporting from Application Connectivity.
CUSTOM_SHELLS
0
Enable reporting user logon events and user interactions in virtualized and embedded environments, for example, in kiosk mode.
Values:
0 – Disable
1 – Enable
DATA_PRIVACY_FILTER
““
Data privacy filters.
DOMAIN_NAME_REPORTING
disable
Enable or disable the reporting of domain names from Application Connectivity.
DRV_ACTIVATE_DMP
0
Specifies whether the target system should be configured to generate memory dumps in case of a STOP message, for example, a System crash.
Values:
0 – Disable
1 – Full memory dump
2 – Kernel memory dump; Nexthink recommends this value
3 – Memory minidump
The MSI package does not change the system setting to a less verbose memory dump. For example, take the following settings:
The system setting generates kernel memory dumps.
DRV_ACTIVATE_DMP is set to 3, which is memory minidump.
In this case, the system setting takes precedence.
DRV_BFBD
0
The delay in seconds during driver initialization before Collector starts communicating with the Nexthink instance.
Maximum value: 240 (equal to 4 minutes)
DRV_CGPI
240
The CrashGuard Protection Interval Value. This is the time interval in minutes since booting, after which a dirty reboot does not increase the CrashGuard.
The default value of 240 minutes equals to 4 hours.
DRV_CRASHGUARD
5
The maximum CrashGuard count that Collector can reach before canceling the load of the driver at boot-time.
0 – Disable CrashGuard feature
DRV_DESC
0
Specifies whether to delay communication socket creation. To avoid traffic blocking by certain firewalls, the system creates the Collector socket layer during the last steps of the initialization.
Values:
0 – Disable
1 – Enable
DRV_DWEF
0
Disables the Windows enumerate functionality.
Values:
0 – Disable function
1 – Collector does not report when Windows freezes or when the application stops responding. Finder does not display any information about the application not responding.
DRV_LOGMODE
0
Specifies the logging mode.
Values:
0 – Silent
1 – Verbose
2 – Debug; this value is not recommended
DRV_LOGSIZE
32
Add log rotation when enabling DRV_LOGMODE for logging.
Value range in megabytes: 1–512
DRV_PKGI
1
The period in hours during which Collector checks for new installed packages and updates, and reports them.
Values range from 0–24, as follows:
0 – Never report packages
1 – Report packages after Collector initializes and then every 1 hour
2–24 – Report packages 45 minutes after Collector initializes; then every 2 to 24 hours
DRV_PREFERIPV6
0
Favor either IPv6 or IPv4 for communicating with the Nexthink instance when the DNS lookup resolves to both IPv6 and IPv4 addresses.
Values:
0 – Use IPv4
1 – Use IPv6
DRV_REACTIVATION
168
Reactivate Collector once the set time has elapsed, after reaching the maximum CrashGuard count. Time is given in hours.
The default value of 168 hours equals to 7 days.
Maximum value in hours: 8766 (equals to 1 year)
DRV_STRING_TAG
–
A string that identifies and organizes installations of Collector.
Values: any string with up to 2048 characters
DRV_TAG
0
An integer that identifies and organizes installations of Collector.
Value range: 0–2147483647
DRV_WEB_AND_CLOUD_DATA
1
(classic) Gather Web and Cloud information.
Values:
0 – Do not record the web connections of devices
1 – Gather and send the data; requires the Web and Cloud product; default value
DRV_WEB_AND_CLOUD_HOSTS
–
(classic) A list of comma-separated host names. The system sends the full URL of each web request for these hosts. This requires the Web and Cloud product and the parameter DRV_WEB_AND_CLOUD_DATA set to 1.
ENGAGE
enable_except_on_server_os
Enable features to engage with end-users either on:
All devices
Devices that are not running a server operating system
Values:
disable
enable
enable_except_on_server_os
INSTALL_BROWSER_EXTENSION
disable
PROXY_ADDRESS
–
The FQDN or IP address of the proxy in manual proxy configuration.
PROXY_PAC_ADDRESS
–
URL of the PAC file to automatically configure the proxy settings.
PROXY_PORT
–
The port number where the proxy is listening in manual proxy configuration.
RA_EXECUTION_POLICY
signed_trusted_or_nexthink
The execution policy of remote actions.
Values:
disabled
signed_trusted
signed_trusted_or_nexthink
unrestricted
RECONNECT_DELAY
60
Maximum delay between reconnects in seconds.
USE_ASSIGNMENT
disable
(classic) Disable the rule-based Collector Assignment. Starting from version 6.19, Collector can be dynamically assigned to Engines and entities based on a set of configurable rules. Set the option to enable to activate rule-based assignment in Collector.
Values:
enable
disable
USER_INTERACTION_TIME_MONITORING
enable
UPN_PRIVACY
hashed
User Principal Name reporting policy.
Values:
cleartext
hashed
no_import
WINDOW_FOCUS_TIME_MONITORING
disable
APP_START_TIME
disable
Enable or disable the App Start Time feature.
ARPNOMODIFY
1
Disables the Add or Remove Programs functionality in the Control Panel. This functionality modifies the product.
In Windows 2000, this disables the Modify button for the product in Add or Remove Programs in the Control Panel.
In earlier operating systems, clicking the Add or Remove Programs button uninstalls the product rather than entering the maintenance mode wizard.
ARPNOREMOVE
–
Setting the ARPNOREMOVE property disables the Add or Remove Programs functionality in the Control Panel. This functionality removes the product.
In Windows 2000, this disables the Remove button for the product from the Add or Remove Programs in the Control Panel.
In earlier operating systems, it removes the product from the list of installed products on the Add or Remove Programs in the Control Panel.
ARPNOREPAIR
–
Disables the Repair button in the Programs Wizard.
ARPSYSTEMCOMPONENT
–
Prevents the application from being displayed in the Add or Remove Programs list of the Control Panel.
DISK_EXCLUSION_LIST
L"NVMe BC711 NVMe SK hynix"
Comma-separated list of disk drivers to exclude from SMART analysis.
REBOOT
–
Suppresses certain prompts for system restart. An administrator typically uses this property with a series of installations to install several products at the same time, with only one restart at the end.
The ForceReboot and ScheduleReboot actions inform the installer to prompt the user to restart the system. The installer can also determine that a restart is necessary based on whether there are any ForceReboot or ScheduleReboot actions in the sequence. For example, the installer automatically prompts a restart if it needs to replace any files in use during the installation.
Values:
Force – Always prompt for a restart at the end of the installation. If there is no user interface, and the installation is not a multiple-package installation, the system automatically restarts at the end. If the installation is a multiple-package installation, there is no automatic system restart and the installer returns the ERROR_SUCCESS_REBOOT_REQUIRED error message.
Suppress – Suppress prompts for a restart at the end of the installation. For example, restart prompts when trying to install a file currently in use. The installer still prompts the user with an option to restart during the installation whenever it encounters the ForceReboot action. If there is no user interface, the system automatically restarts at each ForceReboot.
ReallySuppress – Suppress all restarts and restart prompts initiated by ForceReboot during the installation. For example, restart prompts when trying to install a file in use. Suppress all restarts and restart prompts at the end of the installation.
This setting is non-reversible. Uninstalling Collector 3 does not roll it back to its initial value.
The Collector MSI package does not support this feature. You must set ARPNOMODIFY to 1.