WorkSpaces Manager Agent
The WSM Agent collects information related to both user activity and WorkSpace metrics. The latest version of the WSM Agent installer is always available at the following URL:
https://nuvensworkspacesmanager.s3.eu-west-1.amazonaws.com/latest/WSMAgent.msi
For the agent to function correctly, certain registry key values must be configured so that the agent can identify and connect to the Management Portal API. An example of the required registry key format is shown below. The keys are structured as follows:
[HKEY_USERS\.DEFAULT\Software\Nuvens]
"Portal"="https://portal.nuvens.co"
"Frequency"=dword:00000005
"Visible"="true"
"IdleMinutes"=dword:0000000f
"DisconnectOnIdle"="false"
"LiveBroadcastEnabled"="true"
"LiveBroadcastFrequencyMs"=dword:00001388
"LiveHubUrl"="https://portal.nuvens.co/hubs/livestats"
"RunElevated"="false"The Portal value specifies the location of the WorkSpaces Manager Portal and the protocol used to access it. This value should be defined as a URL and can reference either an IP address or a DNS hostname. For example:
"Portal"="https://portal.nuvens.co"The "Frequency" value specifies how often the WSM Agent reports metrics to the WorkSpaces Manager Portal. This value is expressed in minutes. For example:
This means the agent reports every 5 minutes.
The "Visible" value determines whether the WSM Agent icon is displayed in the Windows system tray. This value accepts true or false. For example:
When set to "true", the WSM Agent icon is visible in the system tray, allowing users or administrators to easily verify that the agent is running.
When set to "false", the icon is hidden from the system tray. However, the WSM Agent continues to run normally in the background. Its execution can still be verified in Task Manager, where it appears as a process named WSMAgent.
The "IdleMinutes" value defines the number of minutes of user inactivity before the WorkSpace is considered idle by the WSM Agent. For example:
This means the agent will treat the session as idle after 15 minutes of inactivity.
The "DisconnectOnIdle" value controls whether the agent should trigger a disconnect action when the session becomes idle. This value accepts true or false. For example:
When set to "true", the agent will disconnect the session after the configured idle threshold is reached. When set to "false", the session remains active even if the user is marked as idle.
To enable Live Stats (Real-Time Metrics) and Startup Metrics, the following additional registry values must be configured:
The "LiveBroadcastFrequencyMs" value controls how frequently these metrics are sent to the portal, expressed in milliseconds.
"LiveHubUrl" must use HTTPS with a trusted certificate. Where TLS is terminated at a load balancer, the WorkSpaces Manager Portal must recognise HTTPS through its trusted reverse proxy configuration.
The RunElevated value allows the WSM Agent to collect Startup Metrics, which require elevated privileges. The agent must be run through a Windows Scheduled Task in the user context with elevated privileges.
To prevent multiple instances of the agent from running, remove WSMAgent.lnk from the Common Startup folder (shell:common startup). The agent should then be started exclusively through the Scheduled Task.
When enabled, Live Stats provide visibility into login performance, including profile loading, GPO processing, Windows shell readiness, and overall login duration. Live Stats also report running processes and their CPU and memory usage.
An example of Startup Metrics and process information is shown below:
From WSM Agent 6.4.1, the agent can report live process usage to WorkSpaces Manager. To allow administrators to terminate processes on WorkSpaces Applications, additional configuration is required.
On each WorkSpaces Manager instance, create the system environment variable:
Generate the shared key once using PowerShell:
On each WorkSpace running the WSM Agent, add the following registry value using the same key:
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