For the complete documentation index, see llms.txt. This page is also available as Markdown.

Configuring and deploying Collector for VMs

This page covers the Nexthink Collector deployment process on VMs, including configuration, auto-update management for non-persistent environments, deployment, and verification.

Before continuing with this procedure, ensure that:

  • You have completed the general prerequisites described in the Before you begin documentation.

  • You have configured the required VDI Platform Connector for your virtualization platform to enable the ingestion of session metadata required by the VDI Experience module. Refer to VDI platform-specific deployment scenarios.

1

Configure Collector for VMs

Configure Collector with the MSI parameters using the Windows Installer. Refer to the following pages for details:

Then add the VM-specific optional parameters to the MST file as described below.

VM-specific optional parameters

Use the following parameters to control VDI platform detection and client latency collection on Windows-based VMs. Apply them in the MST file during installation or in the Windows registry after deployment.

Parameter
Description

VDI_PLATFORM_TYPE

Forces detection of a specific VDI platform when multiple agents are present on a VM. Values:

  • Auto: Default; uses agent registry keys when available

  • AVD: Forces Azure Virtual Desktop detection; prevents Windows 365 detection

  • AWS: Forces AWS detection

  • Citrix: Forces Citrix detection

  • Horizon: Forces Horizon detection

  • Windows365: Forces Windows 365/CloudPC detection

  • Missing or unknown value defaults to auto detection

VDI_CLIENT_PLUGIN_PING_ADDRESS

Sets the host to ping from the client to calculate ISP and WAN latency. The system pushes this information from the VM to the client. Populated NQL data model field: client.network.wan_latency

Key name
Description

Platform

Controls the VDI platform type Collector detects or forces. Location: HKEY_LOCAL_MACHINE\SOFTWARE\Nexthink\Collector\VDI. Values:

  • Auto

  • AVD

  • AWS

  • Citrix

  • Disabled

  • Horizon

  • Windows365

Default (if not set): Disabled.

ClientPingAddress

Sets the IP address used by the connected plugin to calculate ISP and WAN latency.

Location: HKEY_LOCAL_MACHINE\SOFTWARE\Nexthink\Collector\Sessions

Accepts any string

Examples: IPv4 x.y.z.a, IPv6 ::1, domain domain.com.

2

Prevent automatic updates for non-persistent and pooled VDIs

Non-persistent and pooled virtual desktops are typically created from golden images and reset after each session. To prevent these devices from switching between Collector versions, navigate to Administration > Collector management > Update configuration and select Do not update shared and pooled VDI devices.

Refer to Collector management for more information.

3

Prepare a Windows reference image (pooled and shared VDIs only)

When including Collector in a Windows reference image, remove the UID that Collector may have generated to identify the device. Refer to Deploying Collector within a Windows reference image for more information.

4

Deploy Collector on VMs

Deploy Nexthink Collector on all VMs in your virtual infrastructure using the applicable deployment method. Refer to Deploying Collector on Windows for deployment instructions using Active Directory Group Policy or Microsoft Configuration Manager.

5

Verify the deployment

After deployment, verify that your tenant is receiving VDI metrics.

Before verification, ensure that you have configured the required VDI Platform Connector for your virtualization platform.

  • Navigate to Investigations to query the new tables and verify the installation. Refer to VDI Experience NQL capabilities.

  • Verify that session data is available in the Desktop Virtualization dashboards.

Last updated

Was this helpful?