Auto-Sync Environment Changes into ControlUp's Organizational Tree
  • Dark
  • PDF

Auto-Sync Environment Changes into ControlUp's Organizational Tree

  • Dark
  • PDF

You can automatically keep the ControlUp organizational tree up-to-date with the ongoing changes in your environment topology. Our synchronization scripts are run automatically as a Windows scheduled task to read your topology and update ControlUp with added or removed machines. Those changes are automatically reflected in the ControlUp organizational tree and don't have to be made manually. You can continuously monitor the actual machines in your environment and remediate any issues, saving you time and resources.

  • Our sync scripts are written in PowerShell and stored in our GitHub repository .
  • Depending on your VDI, you may have to run special credentials scripts to enable running the sync scripts. These are detailed in the articles covering each environment.
  • You set the Windows scheduled task to automatically run the sync script on the ControlUp monitor machine. This procedure is detailed below.


The following is a list of available types of scripts to synchronize your environment. Click an environment to see further information and instructions on each.

VMware Horizon Sync Scripts

VMware Horizon on Azure Cloud Sync Scripts

Microsoft WVD

Citrix Virtual Apps and Desktops on-premises (CVAD or XenDesktop)

Active Directory Organizational Unit

Citrix Cloud ( early stages of development )

Prerequisites for every sync script

  • The sync has to be performed on a machine that has the ControlUp Monitor component installed. This is because the monitor is the component that communicates with the console 24/7. You can read about Adding a ControlUp Monitor
  • The user has to have ControlUp admin privileges on the ControlUp monitor machine.
  • The monitor machine must have access to credentials to read the changes in the target environment.
  • Powershell version 5.x must be installed on the Monitor machine.

Schedule a Windows Task on the ControlUp Monitor

To enable these scripts to continuously update the ControlUp organizational tree, you create a Windows Scheduled Task on the ControlUp monitor machine to periodically run the scripts.

To set up a Windows Task:

  1. Open the Windows Task Scheduler. Press WIN + R and type taskschd.msc
  2. In the Task Scheduler window, click the Task Scheduler Library and select Create Task in the Action pane as seen below. The Create Task window appears.
  3. In the General tab, provide a new name for the task. Under Security options, click Change Users or Group.
  4. Select the service account used for running the monitor.
  5. Select the Run whether user is logged on or not radio button.
  6. Open the Triggers tab and click New. The configuration window for triggers appears.
  7. From the Begin the task dropdown menu, select On a schedule (1). Click the Daily checkbox (2) and under Recur every, set 1 days (3). Click the Enabled checkbox (4) to automatically enable the trigger after closing this window.

The settings of the scheduler depend on your organization's requirements. If not specified in the script-specific article, our general recommendation is to run all sync scripts once a day.

  1. In the Create Task window, open the Actions tab and click New.
  2. Under Program/script paste the path of the Powershell executable. C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe
    Additionally, you need to define the script arguments, which can be found in the Input parameter section of the corresponding script.

Was this article helpful?