Workspot Agent Silent Installation Process (Template /VDI)

Prev Next

Workspot Agent: 

The Workspot Agent is a software service that runs on Workspot template images, Workspot desktops, and servers running Workspot RD Pools. 

The Workspot Desktop Agent: 

  • Registers the virtual machine (such as Workspot desktops) with Workspot Control if it is not registered already. This registration includes the virtual machine’s IP and Ethernet addresses and everything else needed for Control and admins to identify and track every virtual machine. 

  • Sends status, session information, device capabilities, and performance data to Control, including who is signed in, diagnostic messages, and performance information. 

  • Receives information from Control, such as notifications that a new version of Agent is available or that the VM needs to shut down cleanly. 

Prerequisites: 

  • Access to the Template/Cloud Desktop. 

  • ‘Template Registration Token’ from Customer Control to register Template to Control 

  • ‘Pool Token’ from Customer Control to register Cloud Desktop/VDI/VM to Control 

Template: Agent Silent installation & Registration 

This process would normally be followed when we do not have the Control Admin login and Password available. 

  • In Control, go to “Setup > Configuration > General Settings > Template Registration Token.” 

  • Press the “Regenerate” button (if the Token expires) and then press the “Copy” icon to copy the token. 

  • Login to Template and download the latest Workspot Agent from the location https://download.workspot.com. 

  • Download the WorkspotAgentSetup.msi and keep it the download folder. 

  • Open a CMD window as an administrator. 

  • Navigate to download folder and use the below command for Agent silent installation. 

Command: msiexec /i WorkspotAgentSetup.msi /quiet NoregisterAgent=true 

C:\Users\workspot.admin\Downloads>msiexec /i WorkspotAgentSetup.msi /quiet NoregisterAgent=true 

Once Agent installation is completed, execute the below steps to register Agent with Control 

  • In Command line, navigate to ‘C:\Program Files\WorkspotAgent’ and execute the command below. 

C:\Program Files\WorkspotAgent\auto_template.bat tokenvalue," 

Where the tokenvalue is the Template registration Token copied from Control-> Setup-> Configuration -> General Settings. 

Note: Once Template Registration process is completed, delete Agent from downloaded location.  

Cloud Desktop: Agent Silent installation & Registration 

There could be different scenarios when we need to reinstall the Workspot Agent on the VDI. In such cases, Workspot Agent needs to be installed with silent switch and re-registered with the Control.  

  • User uninstalled the Desktop Agent. 

  • Installed Desktop agent corrupted. 

  • You see two versions of agents installed. 

Agent Silent Installation: 

  • Login to VM (through Utility) 

  • Remove the current installation of an Agent first from the Control Panel, Add andRremove program. 

  • Download the latest Workspot Agent from https://download.workspot.com/ 

  • Download the WorkspotAgentSetup.msi and keep it in the download folder. 

  • Open a command prompt window as an administrator. 

  • Navigate to the download folder and use the below CMD for Agent silent installation. 

CD c:\users\<userID>\Downloads 

  • Then execute the below command: 

msiexec /i WorkspotAgentSetup.msi /quiet NoregisterAgent=true 

VM re-registration with Control: 

To re-register Desktop Agent, agent pool token is required. To get the Agent token for the specific VM of a pool, Login to Control, navigate to Resources -> < Pool Name> ->Agent Token which will be used for reregistering the VM agent. If the Pool token is expired, click on regenerate to get the active new Token.  

  • Login to the error VM with admin credentials  

  • Open Command prompt with elevated permissions 

  • Navigate the path to "C:\Program Files\WorkspotAgent>" and then run the below command. 

C:\Program Files\WorkspotAgent>reregister_poolvm.bat <collected pool agent token> 

  • After the command gets completed, refresh the Control page and verify VM status it should show connected/ready status. 

Please Note: Re-registration created a Workspot Agent Backup folder under C:\Progradata folder. In case you need to re-register the Agent again, please make sure you delete the backup folder first. 

VM is in the error state due to the Agent offline

Workspot Desktops in Control can be in Error state because of multiple reasons. However, if the VM is running and has network connectivity, Agent service is not starting. To resolve such an error, Agent re-registration helps. 

To re-register the Desktop Agent, an agent pool token is required. To get the Agent token for the specific VM of a pool, Login to Control, navigate to Resources -> < Pool Name> ->Agent Token which will be used for reregistering the VM agent. If the Pool token is expired, click on regenerate to get the active new Token. 

  • Login to the error VM with your admin credentials (through Utility or Azure RUN) 

  • Open CMD prompt with elevated permissions 

  • Navigate the path to "C:\Program Files\WorkspotAgent>" and then run the below command. 

  • C:\Program Files\WorkspotAgent>reregister_poolvm.bat <collected pool agent token> 

  • After the command is completed, refresh the control page and verify VM status it should show connected/ready status.