# Installing Collector on Windows {% stepper %} {% step %} Double-click the appropriate Nexthink Collector installer executable file for generating either: * A silent installer:\ `Nexthink_Collector_Installer_Silent.exe` * An installer that opens a command-line window:\ `Nexthink_Collector_Installer.exe` {% endstep %} {% step %} Specify the configuration settings of the Nexthink instance that will receive the data under **Nexthink Appliance settings**: | Address | Use the [URL of your Nexthink instance](#installingcollectoronwindows-prerequisites-1), sometimes referred to as the destination URL. | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | Data over TCP | Select the option to send data over a TCP channel. | | Ports (TCP) | 443 | | Ports (UDP) | This feature must not be selected when using the Nexthink cloud platform. | | DNS | Tick the option **Prefer IPv6** if you want the Collector to favor the use of IPv6 over IPv4 to communicate with the instance. | | {% endstep %} | | {% step %} Set the **General settings**. Optionally tick the box for any additional setting. In particular: 1. Installation options that are not shown in the dialog box take their default value. Check **Install configuration tool** to modify them later with the [Collector configuration tool](/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/deploying-nexthink-in-non-vdi-environment/installing-collector/windows-collector-references/collector-configuration-tool-for-windows.md). In the case of an update, the values of the non-visible settings are preserved from the previous installation. 2. Check the option **Web and Cloud Data** if you have purchased the Web and Cloud product. Furthermore, click the button **Settings** to the right of this option to [open a dialog box where you can list the domains](/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/deploying-nexthink-in-non-vdi-environment/installing-collector/windows-collector-references/reporting-the-url-of-http-web-requests-classic.md) for which you want to store the full URL paths of web requests. That is, for every web request that falls under one of the specified domains, Collector reports the full URL path and not just the domain. 3. Check the option **Use the assignment service** if you have activated the rule-based assignment of Collectors. 4. Select the activation of the **Engage** features depending on the target operating system: * **Enable except on servers**: Collector launches campaigns only on devices that do not run a server operating system. * **Enable on all devices**: Collector launches campaigns on devices with any type of operating system. * **Disable**: Collector ignores campaigns. 5. Select the **Script execution policy** for remote actions that Collector will run on the device: * **Signed by a trusted publisher or by Nexthink** (default): Collector runs on the device, only those remote actions with a PowerShell script that is signed either by Nexthink or by a company whose certificate is listed in the Trusted Publishers certificate store. * **Signed by a trusted publisher**: Collector runs on the device, only those remote actions with a PowerShell script that is signed by a company whose certificate is listed in the Trusted Publishers certificate store. * **Disabled**: Collector runs no remote action on the device. * **Unrestricted**: Collector runs any remote action on the device, regardless of the digital signature of its script. 6. **Optional**: Type in an integer number (0—2147483647) as **Collector tag** to identify the group of Collectors generated with the installer. The Collector tag is useful for defining the entities to build up hierarchies. 7. **Optional**: For more flexibility in the identification of Collectors, type in a label (maximum 2048 characters) as **Collector string tag** to identify the group of Collectors generated with the installer. The Collector string tag is useful for defining the entities to build up hierarchies. 8. Choose the **Customer Key** file that protects the connection to the Nexthink instance. 9. Specify a couple of directories: | Output directory | Select **Browse** to select the folder in which the executable files of both Collector install and uninstall will be created. | | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | | Optional: Logs directory | Type in the network place where Collector deployed with this method must save the installation logs. | | {% endstep %} | | {% step %} Optionally provide the [custom proxy settings of Collector](/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/deploying-nexthink-in-non-vdi-environment/installing-collector/windows-collector-references/windows-collector-proxy-support.md) under the **Proxy configuration** section: 1. Select **Automatic proxy** to provide a PAC file for the automatic configuration of the proxy settings. | PAC address | URL of the PAC file | | ----------- | ------------------- | 2. Select **Manual proxy** to manually provide the proxy settings. | Proxy address | FQDN of the proxy | | ------------- | ------------------------------------------- | | Proxy port | Port number to which the proxy is listening | | {% endstep %} | | {% step %} Click **Create** to trigger the generation of three files: * Executable file to install the Collector:\ `NEXThink_Collector.exe` * Executable file to uninstall the Collector:\ `NEXThink_Collector_Uninstaller.exe` * Text file with the list of the settings used to create the executable installer:\ `NEXThink_Collector.exe.txt` {% endstep %} {% step %} Select **OK** to close the dialog box. {% endstep %} {% endstepper %}
Exit codeDescription
0Success; reboot is not required
-1Success; reboot is required
3Failure; the Collector installation started but msiexec failed
otherFailure; the actual value corresponds to a Windows internal error code
Exit codeDescription
0Success; reboot is not required
-1Success; reboot is required
1Success; Collector was not found and nothing was uninstalled
3Failure; Collector uninstallation started but msiexec failed
otherFailure; the actual value corresponds to a Windows internal error code
ParameterDescription
DRV_IPProvide the FQDN of the Nexthink instance. URL structure: <customer_name>.data.eu.nexthink.cloud
CRD_PORTValue: 443
CRD_KEYProvide a customer key that has been provided to you by your Nexthink representative. Open the key file in text editor, copy the entire text and paste it to the MSI editor as the property value.
DATA_OVER_TCPEnable to send end-user data over the TCP channel of Collector
ParameterDescription
VDI_PLATFORM_TYPE

Force the detection of Citrix or Azure Virtual Desktop (AVD) / Cloud PC (CPC) if there are multiple agents in a given VM.

Values:

  • Auto: Auto detection using agent registry keys when available
  • AVD: Forces AVD detection; prevents Windows365 detection
  • AWS: Forces AWS detection
  • Citrix: Forces Citrix detection
  • Horizon: Forces Horizon detection
  • Windows365: Forces Windows 365 / CloudPC detection
  • Missing or unknown value: Auto detection using agent registry keys when available
VDI_CLIENT_PLUGIN_PING_ADDRESSSet the host to ping from the client to calculate ISP and WAN latency. This information is pushed from the VM to the client.
Populated NQL data model field: client.network.wan_latency
Key nameDescription
Platform

Controls the VDI platform type that the Collector detects or forces to use.

Location: HKEY_LOCAL_MACHINE\SOFTWARE\Nexthink\Collector\VDI

Possible values:

  • Auto: Auto detection using agent registry keys when available
  • AVD: Forces AVD detection; prevents Windows365 detection
  • AWS: Forces AWS detection
  • Citrix: Forces Citrix detection
  • Disabled: Detection disabled
  • Horizon: Forces Horizon detection
  • Windows365: Forces Windows 365 / CloudPC detection

If not set, the default value is Disabled.

  • Missing or unknown value: Auto detection using agent registry keys when available.
ClientPingAddress

Selects which IP address will be used by the connected plugin to calculate ISP and WAN latency.

Location: HKEY_LOCAL_MACHINE\SOFTWARE\Nexthink\Collector\Sessions

Any string is a valid value. Examples:

  • IPv4: x.y.z.a
  • IPv6: ::1
  • Domain: domain.com
{% stepper %} {% step %} Double-click the `NEXThink_Collector.msi` file to start the installation program. {% endstep %} {% step %} After reading the welcome message, select **Next**. {% endstep %} {% step %} Fill out the form of installation settings: | | | | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Appliance Name or IP address | FQDN of your Nexthink instance | | Appliance TCP Port | 443 | | Customer Key |

Copy to this field the content of the file that holds the customer key of the Nexthink instance:

  1. Open the customer key file using Notepad.
  2. Press Ctrl+A to select all the text.
  3. Press Ctrl+C to copy the text.
  4. Back in the Customer Key field, press Ctrl+V to paste the copied key.
| | {% endstep %} | | {% step %} Select **Next**. {% endstep %} {% step %} The installer is now ready and you can click **Install** to begin the actual installation. {% endstep %} {% step %} Click **Finish** to close the installation wizard once it has been completed. {% endstep %} {% endstepper %} | Parameter | Description | | ---------- | ----------------------------------------- | | `DRV_IP` | FQDN of your Nexthink instance | | `CRD_PORT` | 443 | | `CRD_KEY` | The customer key of the Nexthink instance | | Field | Description | | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Name | A unique name for the collection. | | Comment |

Optional field

Comment describing the intent of the collection.

| | Limiting collection |

Optional field

Click Browse to select a collection that puts a limit on the members of the current collection or select All systems in order to not limit the current collection.

|
KeyHKEY_LOCAL_MACHINE\SOFTWARE\Nexthink\Collector\VDI
NameIcaVideoMetricsInterval
Enabled Valuedword:00000003
Disabled Valuedword:00000000 or missing value
| `DRV_CRASHGUARD` | The maximum number of consecutive abruptly terminated sessions after which Collector cancels the loading of its drivers. Default is five sessions. | | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `DRV_CGPI` | The time interval in minutes after system startup during which the CrashGuard protection mechanism recognizes abrupt terminations as genuine crashes. Default is 240 min (4 hours). | | `DRV_REACTIVATION` | The waiting time, expressed in hours, from the moment that the loading of Collector is deactivated because the CrashGuard counter reached its maximum specified count until the moment it is reactivated. Default is 168 hours (7 days). | The following sections explain the Collector installation and deployment methods in detail. See the [Installing Collector](/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/deploying-nexthink-in-non-vdi-environment/installing-collector.md) documentation to learn how to decide on the installation and deployment method applicable to your infrastructure. ## Before you begin Before you begin the installation procedure, ensure you have the following things: * URL of your Nexthink instance, including `data` in the path:\ `.data..nexthink.cloud`\ For more information about the URL, see the [Connectivity requirements](/platform/configuring_nexthink/before-you-begin/technical-requirements/connectivity-requirements.md). * One or more Windows devices on which to install Collector. * Administrator credentials in your Nexthink instance. * The Collector installation package; see the obtaining Collector section. * The customer key in the `Customer Key.txt` file, which you receive in your welcome email from Nexthink. * The root certificate associated with your Nexthink instance. * **Optional**: A third-party deployment tool or Unified Endpoint Manager (UEM), such as Microsoft Intune. {% hint style="warning" %} Ensure that no version of Nexthink Collector is running on the Windows instance. When applicable, uninstall the existing Collector version. {% endhint %} ## Installation procedure overview This section outlines the installation procedure and the decisions you have to take before and during the process. On a high level, the procedure includes the following steps: ```mermaid %%{ init : { "theme" : "default", "flowchart" : { "curve" : "linear" }}}%% flowchart LR n1(Meet general prerequisites) --> n2(Obtain Collector) --> n3(Select Collector artifact) --> n4(Configure Collector) --> n5(Install and test Collector on one device) --> n6(Deploy Collector to the rest of devices) ``` {% hint style="info" %} VDI Client Extension is enabled automatically for all devices in your environment when using VDI Experience. Ensure you are using Collector version 25.4.1 or above. For older Collector versions, Nexthink recommends upgrading to the most recent Collector version to ensure that the VDI Client Extension is enabled without requiring redeployment. {% endhint %} Proceed by reading the relevant section based on the endpoint agent you selected in the previous step. ### Collector installation overview This section outlines the Collector installation process. To get started, take the [small-scale setup](#installing-collector-for-small-scale-setup) or [medium to large-scale setup](#installing-collector-for-medium-to-large-scale-setup) installation path based on the scale of your environment. #### Installing Collector for a small-scale setup Small-scale setups include, for example, proof-of-concept scenarios and unmanaged environments. 1. Obtain [Collector](#obtaining-collector) 2. Configure Collector with your client information using the [Nexthink Collector Installer](#installingcollectoronwindows-prerequisites-3) or the [Windows Installer](#installingcollectoronwindows-deployingcollectorusingactivedirectorygrouppolicy) 3. Install Collector on a [single endpoint device](#installingcollectoronwindows-installingcollectoronasingledevice-1) 4. Ensure a good connection to your Nexthink instance; if needed, troubleshoot by reconfiguring Collector 5. Manually install Collector on the rest of the endpoint devices #### Installing Collector for a medium to large-scale setup Medium to large-scale setups include managed IT environments with, in many cases, thousands of endpoint devices. Select your device type from the following tabs to see the installation steps. {% tabs %} {% tab title="Physical endpoint device" %} 1. Understand the [general prerequisites](#installingcollectoronwindows-prerequisites-1) 2. Obtain [Collector](#obtaining-collector) 3. Configure Collector with your client information using the [Windows Installer](#installingcollectoronwindows-deployingcollectorusingactivedirectorygrouppolicy) 4. Install Collector on a [single endpoint device](#installingcollectoronwindows-installingcollectoronasingledevice-1) 5. Ensure a good connection to your Nexthink instance; if needed, troubleshoot by reconfiguring Collector 6. Deploy Collector to the rest of the endpoint devices using a [deployment method](#installingcollectoronwindows-deployingcollectorusingactivedirectorygrouppolicy-1) applicable to your infrastructure {% endtab %} {% tab title="VM" %} 1. Install the appropriate [virtualization connector](#connectors) for your environment 2. If needed, disable [auto-updates for non-persistent VDI](#disable-auto-updates-for-non-persistent-vdi) 3. Deploy Collector on the VMs using a [deployment method](#installingcollectoronwindows-deployingcollectorusingactivedirectorygrouppolicy-1) applicable to your virtual infrastructure 4. If you are deploying Collector within a Windows reference image, follow the steps in [the relevant section here](#installingcollectoronwindows-deployingcollectorwithinawindowsreferenceimage) {% endtab %} {% endtabs %} *** Perform the deployment by following the procedures in the relevant subsections in this documentation: * [Obtaining Collector](/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/deploying-nexthink-in-non-vdi-environment/installing-collector/installing-collector-on-windows/obtaining-collector.md) * [Configuring Collector for endpoint devices](/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/deploying-nexthink-in-non-vdi-environment/installing-collector/installing-collector-on-windows/configuring-collector-on-device-tp.md) * [Configuring Collector for VMs](/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/deploying-nexthink-in-non-vdi-environment/installing-collector/installing-collector-on-windows/configuring-collector-on-vm-tp.md) * [Installing Collector on a single device](/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/deploying-nexthink-in-non-vdi-environment/installing-collector/installing-collector-on-windows/installing-collector-on-device-tp.md) * [Installing Collector on VMs](/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/deploying-nexthink-in-non-vdi-environment/installing-collector/installing-collector-on-windows/installing-collector-on-vm-tp.md) * [Deploying Collector](/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/deploying-nexthink-in-non-vdi-environment/installing-collector/installing-collector-on-windows/deploying-collector-on-windows-tp.md) --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.nexthink.com/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/deploying-nexthink-in-non-vdi-environment/installing-collector/installing-collector-on-windows.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.