WorkSpaces Manager Agent
RECOMMENDED FOR FULL FUNCTIONALITY: The WSM Agent requires .NET 4.6.2 or above. Ensure that this version or a later version of .NET is installed on the EC2 instance to enable all features of the WSM Agent.
The WSM Agent collects information for both user and WorkSpace metrics. The Agent installer, named 'WSM Performance Monitor.msi', can be found in the following locations:
D:\WorkSpaceAgent on the WorkSpaces Manager (WSM) appliance, or
D:\Deploy folder for successive updates.
Alternatively you can download the latest agent from https://nuvensworkspacesmanager.s3.eu-west-1.amazonaws.com/latest/WSMAgent.msi
For the Agent to function properly, it requires specific registry key values to be present in order to locate the API on the Management Portal. A sample format for these registry keys can be found in "D:\WorkSpaceAgent\nuvens.reg", and they are structured as follows:
[HKEY_USERS\.DEFAULT\Software\Nuvens]
"Portal"="https://10.0.1.2"
"UpdateFrequency"="60"
"Frequency"=dword:00000005
"IdleMinutes"=dword:00000015
"Visible"="true"Replace the value of "Portal" in the registry key file with the IP address or DNS name of your WorkSpaces Manager Portal. Ensure that you select the correct protocol, HTTP or HTTPS, based on your WorkSpaces Manager Portal configuration.
The "Frequency" value defines how often the WSM Agent reports metrics to the portal, expressed in minutes.
For example:
"Frequency"=dword:00000005This means the agent reports every 5 minutes.
For environments with a large number of WorkSpaces, increasing this value can help reduce database load and improve performance.
For Live Stats (Real-Time Metrics) and Startup Metrics The following additional registry values are required:
The "LiveBroadcastFrequencyMs" value is set in milliseconds and controls how frequently real-time performance data is broadcast to the portal.
The "RunElevated" value is required for Startup Metrics and enables the agent to run with elevated permissions.
If Startup Metrics are required, additional configuration is necessary to change how the agent starts. Instead of launching from the Windows Startup folder, the agent must be configured to run as a Scheduled Task at user logon. Running the agent as a Scheduled Task allows it to start with the highest privileges without granting additional permissions to the user.
For full configuration steps, see the GPO Scheduled Task Setup Instructions.
Live Stats provide real-time performance metrics when viewing a WorkSpace, while Startup Metrics deliver detailed login performance insights, including profile load and policy processing times.
There are several ways to deploy the registry settings on your WorkSpaces. Some common methods include:
Add Manually to Golden Images: Apply the registry settings directly to your golden images, ensuring that all cloned WorkSpaces inherit the correct configurations.
Group Policy (GPO): Distribute the registry settings via Group Policy (GPO) using Active Directory, which automates the process for all WorkSpaces in the domain.
Microsoft Intune (Entra ID Hybrid): Use Intune to distribute the registry settings when managing devices with Entra ID Hybrid for centralized control.
Distribution Tool (e.g., SCCM): Leverage distribution tools like System Center Configuration Manager (SCCM) to push registry settings across your WorkSpaces fleet.
AWS Systems Manager: Use the AWS Systems Manager Run Command or State Manager to push the registry settings across your fleet of WorkSpaces.
PowerShell Scripts: Create a PowerShell script that modifies the registry with the required values.
Logon Scripts: Add a registry modification script to the logon process of the WorkSpaces, ensuring that each user gets the settings applied upon login.
Configuration Management Tools: Use tools like Chef, Puppet, or Ansible to automate the deployment of registry settings across WorkSpaces.
Last updated