Workspot Agent (v2.1+) Installation for Templates

Donald Van Patten -

Workspot Agent Installation for Templates

The Workspot Agent is software that is installed on VDI or RD Pools templates that enables provisioned machines to register with Workspot Control. Workspot Agent communicates status, session information and performance data to Workspot Control. During provisioning, the Workspot Agent domain joins machines. 

Workspot Agent will auto-update for persistent VDI desktops and RD Pools. For non-persistent VDI desktops, Workspot recommends upgrading to the latest Workspot Agent through the VDI pool Image Update process.


Note: Before installing the Workspot agent, shut down the template VM. Run the clone functionality on the template VM (save the original) and then boot into the new clone template. Note that the Workspot Agent will register the template to Workspot Control using the MAC address of the VM so once the template is registered and sysprep, no changes can be made. For future changes or updates, use the original template VM and clone again for use (saving the original again for future changes). Thus, the process is: Original template > Clone template > Install Agent > Use this template for cloning > when updating or modifying, use the original template for this process again.

Download the Workspot Agent installer from:

As an administrator, run the Workspot Agent installer and use Workspot Control (administrator role credentials required) to register the template. 

02-WorkspotAgentSetupWizard.jpg 04-WorkspotAgentSetupControlAdmin.jpg 


Preparing template for Workspot Control provisioning

1. Create a service admin account that can join machines to the domain. Workspot recommends creating a service account that only have permissions for specific OUs in Active Directory where provisioned machines will reside. 

2. Copy sample Workspot XML config file provided after the install of the Workspot Agent. Sample file is located in the install folder of the Workspot Agent: c:\Program Files\Workspot Agent\

3. Modify the XML config file with service admin account credentials along with OU info.

Note: If password or any other parameters contains special characters, it must be escaped (i.e. OU=Workspot&Co is OU=Workspot&Co). Review table in appendix of this document.


<?xml version="1.0" encoding="utf-8"?>
<component name="Workspot-DomainJoin" language="neutral">

4. Copy Workspot XML config file to c:\windows\system32\config\systemprofile\appdata\local\workspot agent\config.

Note: The Workspot XML config file will be deleted during provisioning.

Sysprep vs Quickprep

Workspot VDI 2.0 Pools and RD Pools can be either Sysprep or Quickprep.

Task Sysprep Quickprep
Computer name change YES YES
Join domain YES YES
Generate new SID  YES NO
Customization outside template YES NO

For Quickprep:
Shutdown the template VM. Template is now ready for Workspot Control provisioning. 

For Sysprep:

1. Create a sysprep unattend.xml answer file for Windows customization and save it in a location like c:\temp.  

The following Windows 10 sample file: Windows 10 Sample file

  • Skips welcome screens.
  • Creates a local administrator account.

NOTE: You can add parameters as needed (such as time zone, language and so on).

2. Create SetupComplete.cmd to delete unattended.xml answer file after sysprep. Copy the SetupComplete.cmd to c:\windows\setup\scripts\. Unattend.xml may contain sensitive information. 


3. Sysprep the VM with the following command:
C:\Windows\System32\sysprep\sysprep.exe /shutdown /oobe /generalize /unattend:c:\temp\unattend.xml


NOTE: This command will sysprep the VM and then shut down the VM. After the VM is powered on, it will go through the sysprep process.

The template is now ready for Workspot Control provisioning.



For installation and template registration issues, see the logs file in: C:\Program Files\WorkspotAgent\InstallLog
For runtime issues, see the log file in: C:\Windows\System32\config\systemprofile\AppData\Local\WorkspotAgent\Log


Special characters in WorkspotConfig.xml

Original Character Replacement character
" &quot;
' &apos;
< &lt;
> &gt;
& &amp;
Have more questions? Submit a request


Powered by Zendesk