Collector MSI parameters reference table

Contents

Collector MSI parameters reference table

Applies to platforms: PlatformWindows.png

Mandatory parameters

Option Name Default value Description
DRV_IP - Set the Engine IP or DNS name
DRV_PORT - Set the Engine port number
CRD_PORT - Engine non-traffic TCP port number
CRD_KEY - Customer Key of the Engine Appliance
CRD_ROOT_CA - Root CA of the Engine Appliance -mandatory only if using Nexthink PKI

Optional parameters

Option Name Default value Description
CFG_INSTALL 1 Install the Nxtcfg tool for changing the configuration of the Collector from the command line. 1: install, 0: do not install
CPL_INSTALL 0 Install the Collector Control Panel extension. 1: install, 0: do not install
DRV_ACTIVATE_DMP 0 Specifies whether the target system should be configured for generating memory dumps in case of STOP message (System crash). Its value can be 0 (disabled), 1 (full memory dump), 2 (kernel memory dump) and 3 (memory minidump). The recommended value is 2 (kernel memory dump).
  • This is a non-reversible setting: it will not be rolled back to its initial value after uninstalling Collector 3.
  • The MSI package will not change the system setting for a less verbose memory dump setting (e.g. if current setting is to generate kernel memory dumps and DRV_ACTIVATE_DMP is set to 3 (memory minidump), no action will be performed)
DRV_BFBD 0 Delay in seconds during initialization of the driver before we start sending UDP packets to the Engine. Maximum value: 240 (4 min)
DRV_CRASHGUARD 3 Specifies the maximum CrashGuard count that the Collector can reach before canceling the loading of the driver at boot-time. If set to 0, the CrashGuard feature will be disabled
DRV_DESC 0 Delay Engine communication Socket Creation : To avoid having the traffic blocked by certain firewalls, the Collector socket layer is created during the last initialization steps. [1: enable, 0: disable]
DRV_LOGSIZE 32 Addition of log rotation when enabling DRV_LOGMODE for the logging [Range for value: 1 -> 512 (MB)].
DRV_REACTIVATION 168 Reactivate the Collector once the given time (in hours) has elapsed after it reached the maximum CrashGuard count. The max value is 8766 hours (1 year). Default is 7 days (168 hours).
DRV_TAG 0 Assign to any installer to help you organize and remember the creator of the installation. Possibles values are 0 to 2147483647.
DRV_LOGMODE 0 Specifies the logging mode. Possible values are 0, 1 and 2, meaning Silent, Verbose and Debug, respectively. 2 (Debug) is not recommended.
DRV_DWEF 0 Disables Windows enumerate functionality. Possible values are 0, 1. If set to 1, the Collector does not report any Windows freeze or hung problems.

(This will result in the Finder not displaying any information about "application not responding".)

DRV_CGPI 0 “CrashGuard Protection Interval Value”. It is the time interval since boot (in minutes) after which a dirty reboot does not increase the CrashGuard.
DRV_MSS 1224 Maximum size of the UDP packet for transfers between the Collector and the Engine. Allowed values range from 1000 to 16384.
DRV_PKGI 1

Period, in hours, in which the Collector checks for new installed packages and updates and reports them. Allowed values range from 0 to 24:

  • 0 - Never report packages.
  • 1 - Report packages after Collector initializes and then every 1 hour.
  • 2-24 - Report packages 45 minutes after Collector initializes and then every 2 to 24 hours.
DRV_WEB_AND_CLOUD_DATA 1 Gather Web and Cloud information. Default value is 1 to gather and send the data (only if you have purchased the Web and Cloud module). Set to 0 for not recording the web connections of devices.
DRV_WEB_AND_CLOUD_HOSTS - List of comma separated host names for which to send the full URL of each web request. Requires the Web and Cloud module and the parameter DRV_WEB_AND_CLOUD_DATA to be set to 1.
PRINTING disable Disable print notifications. Starting from version 6.18 the Collector does not report printing information by default. Set the option to enable to report printing activity and to disable to not report it.
DRV_DSPS 1 Disable SMB print notifications. Starting from version 5.2.8.0, the Collector does not report SMB prints by default. Set the option to 0 to enable SMB print reporting (requires PRINTING enabled). Set to 1 to disable it.
DRV_PREFERIPV6 0 Favor IPv6 over IPv4 (or viceversa) for communicating with the Engine. When the DNS lookup of the name of the Engine resolves to both IPv6 and IPv4 addresses, prefer IPv6 when set to 1 and IPv4 when set to 0.
CUSTOM_SHELLS 0 Enable the reporting of user logon events and user interactions in virtualized and embedded (kiosk mode) environments. Set to 1 to enable.
RA_EXECUTION_POLICY signed_trusted_or_nexthink

Execution policy of remote actions. Possible values:

  • unrestricted
  • signed_trusted
  • signed_trusted_or_nexthink
  • disabled
USE_ASSIGNMENT disable Disable the rule-based Collector Assignment. Starting from version 6.19 the Collector can be dynamically assigned to Engines and entities based on a set of configurable rules. Set the option to enable to activate the rule-based assignment in the Collector.

Windows parameters

Option Name Default value Description
ARPNOREMOVE - Setting the ARPNOREMOVE property disables the Add or Remove Programs functionality in Control Panel that removes the product. For Windows 2000, this disables the Remove button for the product from the Add or Remove Programs in Control Panel. For earlier operating systems, this has the effect of removing the product from the list of installed products on the Add or Remove Programs in Control Panel.
ARPNOREPAIR - Set the ARPNOREPAIR property to disable the Repair button in the Programs Wizard.
ARPSYSTEMCOMPONENT - Setting the ARPSYSTEMCOMPONENT property to 1 using the command line or a transform prevents the application from being displayed in the Add or Remove Programs list of Control Panel.
ARPNOMODIFY 1 Setting the ARPNOMODIFY property disables Add or Remove Programs functionality in Control Panel that modifies the product. For Windows 2000, this disables the Modify button for the product in Add or Remove Programs in Control Panel. On earlier operating systems, clicking the Add or Remove Programs button uninstalls the product rather than entering the maintenance mode wizard.

Note: the Collector MSI package does not support this feature. ARPNOMODIFY must bet set to 1.

REBOOT - The REBOOT property suppresses certain prompts for a restart of the system. 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 whether there are any ForceReboot or ScheduleReboot actions in the sequence. For example, the installer automatically prompts for a restart if it needs to replace any files in use during the installation.

You can suppress certain prompts for restarts by setting the REBOOT property as follows.

REBOOT = Force Always prompt for a restart at the end of the installation. The UI always prompts the user with an option to restart at the end. If there is no user interface, and this is not a multiple-package installation, the system automatically restarts at the end of the installation. If this is a multiple-package installation, there is no automatic restart of the system and the installer returns ERROR_SUCCESS_REBOOT_REQUIRED.

REBOOT = Suppress Suppress prompts for a restart at the end of the installation. 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. Restarts at the end of the installation (for example, caused by an attempt to install a file in use) are suppressed.

REBOOT = ReallySuppress Suppress all restarts and restart prompts initiated by ForceReboot during the installation. Suppress all restarts and restart prompts at the end of the installation. Both the restart prompt and the restart itself are suppressed. For example, restarts at the end of the installation, caused by an attempt to install a file in use, are suppressed.

Starting from V6, the Collector is usually able to upgrade without the need to reboot the device. Only when migrating from V5 or when the target device interferes with the installation process (for instance, by running the Collector Control Panel extension during installation), a reboot is necessary. Set the REBOOT option in these cases to specify your choice.

For instance, if you do not want your devices to reboot right away after a V5 to V6 migration, set REBOOT=ReallySuppress. As a drawback, if you set this option, the upgrade to V6 will not be complete until the end-users reboot their devices.

In unattended execution mode, all choices are silently accepted. For example, if REBOOT=Force, the computer will automatically be rebooted after the MSI package installation.

Casing of properties

Always specify the names of the parameters (the properties) of the MSI in capital letters. If you include the properties with lower case letters in an MST, they will be considered private properties and you will not be able to modify them later from the command-line.

The operations described in this article should only be performed by a Nexthink Engineer or a Nexthink Certified Partner.

If you need help or assistance, please contact your Nexthink Certified Partner.