| Exit code | Description |
|---|---|
| 0 | Success; reboot is not required |
| -1 | Success; reboot is required |
| 3 | Failure; the Collector installation started but msiexec failed |
| other | Failure; the actual value corresponds to a Windows internal error code |
| Exit code | Description |
|---|---|
| 0 | Success; reboot is not required |
| -1 | Success; reboot is required |
| 1 | Success; Collector was not found and nothing was uninstalled |
| 3 | Failure; Collector uninstallation started but msiexec failed |
| other | Failure; the actual value corresponds to a Windows internal error code |
| Parameter | Description |
|---|---|
DRV_IP | Provide the FQDN of the Nexthink instance. URL structure: <customer_name>.data.eu.nexthink.cloud |
CRD_PORT | Value: 443 |
CRD_KEY | Provide 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_TCP | Enable to send end-user data over the TCP channel of Collector |
| Parameter | Description |
|---|---|
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:
|
VDI_CLIENT_PLUGIN_PING_ADDRESS | Set 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 name | Description |
|---|---|
Platform | Controls the VDI platform type that the Collector detects or forces to use. Location: Possible values:
If not set, the default value is Disabled.
|
ClientPingAddress | Selects which IP address will be used by the connected plugin to calculate ISP and WAN latency. Location: Any string is a valid value. Examples:
|
Copy to this field the content of the file that holds the customer key of the Nexthink instance:
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.
| Create a boundary and add it to a boundary group: {% stepper %} {% step %} In the Configuration Manager console, go to the **Administration** workspace. {% endstep %} {% step %} Right-click **Boundaries** and select **Create Boundary**. {% endstep %} {% step %} Define the boundary by setting additional restrictions on the target devices in which to push the software installation, for example, by IP address range. {% endstep %} {% step %} Right-click **Boundary Groups** and select **Create Boundary Group**. {% endstep %} {% step %} Type in a name for the group. {% endstep %} {% step %} Add the previously created boundary to this group. {% endstep %} {% step %} **Optional**: Verify that you added the correct number of devices to the group by looking at the value in the column **Member Count**. {% endstep %} {% endstepper %} Create the application to install: {% stepper %} {% step %} In the Configuration Manager console, go to the **Software Library** workspace. {% endstep %} {% step %} Right-click **Applications** and select **Create Application**. {% endstep %} {% step %} Choose the option **Manually specify the application information**. {% endstep %} {% step %} Specify the location and name of the application; in this case, `Nexthink_Collector_Installer_Silent.exe`. The new application is added to the list of available applications. {% endstep %} {% endstepper %} Now the new application should appear in the list. When you click it, there is a **Deployments** tab at the bottom of the window. Later this tab will show a list of deployments of this application to different device groups. Distribute and deploy the application: {% stepper %} {% step %} In the list of **Applications**, right-click the previously created Collector application and select **Distribute Content**. The distribution wizard opens. 1. Confirm the correct executable file of the installer, which is `Nexthink_Collector_Installer_Silent.exe`. 2. As **Content Destination**, select **Distribution Point**. 3. Specify the shared folder that holds the installer. {% endstep %} {% step %} **Optional**: Survey the distribution process from the Configuration Manager console. 1. In the main panel, navigate to **Monitoring** > **Distribution Status** > **Content Status**. 2. Click the application that you have just distributed. If you see **Success** and a green-colored graph below, you can now deploy the application. {% endstep %} {% step %} Back in the **Software Library** workspace, navigate to **Applications**. {% endstep %} {% step %} Right-click the Collector application and select **Deploy**. 1. Select the collection of devices that you created earlier. * If you cannot see your collection in the list, switch from **User Collections** to **Device Collections**. 2. Check that the distribution point is correct and click **Next**. 3. Set **Action** to **Install** and **Purpose** to **Required** and click **Next**. 4. Set the **Schedule** to an appropriate moment to start the deployment, for example **As soon as possible**, and click **Next**. 5. Tick **Software installation** and click **Next**. 6. Accept the default options for the rest of the wizard. {% endstep %} {% step %} **Optional**: Check the status of your deployment in the **Deployments** tab at the bottom of the window. {% endstep %} {% endstepper %} To verify the deployment on a client device, log in to the client device and wait for the pop-up notification about the installation of new software. To speed up this process, manually force the software deployment evaluation cycle in the Microsoft Configuration Manager client: {% stepper %} {% step %} Open the **Control Panel**. {% endstep %} {% step %} Navigate to **Configuration Manager** and click the **Actions** tab. 1. Choose **Machine Policy Retrieval & Evaluation Cycle** and click **Run Now**. 2. Choose **Application Deployment Evaluation Cycle** and click **Run Now.** {% endstep %} {% endstepper %} To debug the deployment process and see its log files, check the following: * On the server machine, open Microsoft Configuration Manager to view log files\ `C:\Program Files\Microsoft Configuration Manager\tools\cmtrace.exe` * The server logs are stored in\ `C:\Program Files\Microsoft Configuration Manager\Logs\` * On the client machine, the logs are stored in one of these three paths: * `C:\Windows\CCM\` * `C:\Windows\ccmsetup\` * `C:\Windows\ccmcache\` If your deployment is not successful, check the following troubleshooting points: * In the Configuration Manager console, navigate to **Administration** > **Site Configuration** > **Servers and Site System Roles** and choose your server. In the table below, right-click **Distribution point** and select **Properties**. In the **Boundary Groups** tab, verify that the boundary group that you previously created is listed in the **Boundary Groups list**. If not, add it to the list. * In the Configuration Manager console, navigate to **Software Library** > **Applications**. Right-click the Collector application and select **Properties**. Verify the following points: * In the **Distribution Settings** tab, ensure that the option **Distribute the content for this package to preferred distribution points** is ticked. * In the **Content Locations** tab, make sure that your distribution point (the path to your shared folder) is in the table. If not, add it, and click **Redistribute**. * If the remote installation fails with error code `0x87d00324` (displayed in Software Center on the client machine), the installation itself was in fact successful and Collector should be running. It is the mechanism for detecting the installation of the application which has failed. In this case, check the detection criteria: 1. In **Software Library**, right-click the deployed Collector application and select **Properties**. 2. In the tab **Deployment Types**, double-click the installer script in the list **Detection Method**. 3. Check if the detection method is configured correctly. Since you are using the Collector installer executable, the detection should be done by a registry key. ### Deploying Collector within a Windows reference image When including Collector in a Windows reference image, remove the UID that Collector may have generated to identify the device. To ensure the removal of the device UID: {% stepper %} {% step %} Log in to the Windows device with Collector as a user with administrative rights. {% endstep %} {% step %} Select **Start** and type `cmd` in the search bar to show the Command Prompt application. {% endstep %} {% step %} Right-click the Command Prompt icon and select **Run as administrator** in the context menu. {% endstep %} {% step %} Stop Collector by running the following command in the Command Prompt: ```shellscript nxtcfg.exe /stop ``` {% endstep %} {% step %} Remove the UID of the device by running the following command in the Command Prompt: ```shellscript reg delete "HKLM\SYSTEM\CurrentControlSet\Services\Nexthink Coordinator\params" /v uid ``` {% endstep %} {% step %} To the question **Delete the registry value uid (Yes/No)?**, type `yes`. {% endstep %} {% step %} Remove the license\_UID of the device by running the following command in the Command Prompt: ```shellscript reg delete "HKLM\SYSTEM\CurrentControlSet\Services\Nexthink Coordinator\params" /v license_uid ``` {% endstep %} {% step %} To the question **Delete the registry value license\_uid (Yes/No)?**, type `yes`. {% endstep %} {% endstepper %} {% hint style="info" %} The system confirms that the operation was successful or displays instead an error message if Collector has not generated the UID yet. {% endhint %} ## Registry configuration reference This section describes Collector features you can enable by editing Windows Registry on the client devices. ### Enabling ICA Video metrics Fetching the ICA Video metrics from the WMI API can impact system resources, such CPU consumption. Therefore, this feature is disabled by default. To enable the feature and determine the intervals at which these metrics are fetched, edit the following registry key:| Key | HKEY_LOCAL_MACHINE\SOFTWARE\Nexthink\Collector\VDI |
| Name | IcaVideoMetricsInterval |
| Enabled Value | dword:00000003 |
| Disabled Value | dword:00000000 or missing value |