Auto-sync Environment Changes into ControlUp's Organizational Tree

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.

Environments

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)

Citrix Cloud (early stages of development)

Active Directory (article under construction)

Note: You can access the Active Directory sync script here in our GitHub repository and use the descriptions at the beginning of the script to understand the different parameters you can use.

 

Prerequisites for every sync script

  • The sync has to be performed on a machine which has the ControlUp monitor component installed. You can read about Adding a ControlUp Monitor.
  • 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.

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 create a scheduled task:

Note: 
The steps here are based on the latest Windows version. As this is third party software, we cannot guarantee the specific field names and steps but are giving you the most updated information as of the date we are publishing this article.

  1. Open the Task Scheduler from the Start menu and select Create Task... from the Actions menu and the Create Task screen appears.
  2. In the General tab, enter a Name for the new task to sync ControlUp with your environment and select Run whether user is logged on or not in the Security options.
  3. From the Triggers tab:
    • Add a new trigger, by clicking New..., and the New Trigger window appears.
    • From the Begin the task drop-down box, choose On a schedule and choose when to start the task in Task Scheduler, and set the Recur every box to 1 day.
      (The scheduled task can be run as often as every five minutes. The time you set also will be the time the task runs daily.)
  4. From the Actions tab:
    • Click New..., and select Start a program from the Action section.
    • From the Program/script section, choose “powershell.exe” (located in C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe)
    • Add the relevant arguments as described in the articles per environment.
  5. In the Conditions tab, you may keep the default selection or modify. 
  6. In the Settings tab, select the following:
    • Allow task to be run on demand
    • Stop the task if it runs longer than: (Recommended: 3 days)
    • If the running task does not end when requested, for it to stop
    • Do not start a new instance (from the drop down menu)
  7. Once all the details have been set, click OK, and the new task is created.
1-on-1 Demo
Schedule now
Price Quote
Get it now
Need a Script?
Get it here
Powered by Zendesk