Built-in Folder Synchronization

You can use the Real-Time DX Console to synchronize folders and machines to your organization tree from your AVD or EUC environments, such as CVAD, Horizon, and Citrix Cloud. This means that you don’t need to use the PowerShell-based sync script to synchronize your environments. From version 9.1, folder mappings are also included in the built-in sync feature.

You can configure built-in sync for the following mappings:

• DNS

• Site

• Folder

Prerequisites

• Monitors must run version 9.0 or higher

• User actions to be allowed in the ControlUp Security Policy:

  • Add Folder

  • Add Machine

  • Remove Folder

  • Remove Machine

• Monitors need to have an active connection to the cloud and EUC environments as the monitors that monitor the connections are responsible for automatically synchronizing the organization tree.

Enable Built-in Synchronization

To enable built-in synchronization:

1. Right-click on a connection under your organization's folder. Select Connection Settings and click Edit Sync Options.

    

2. Check the Enable built-in synchronization option and adjust your synchronization settings as necessary.

    

3. Optionally, consider the following adjustments:

   1. Check Include existing computers to enable computer movements between any folders. Unchecked, only machines within the synced Cloud Connection/EUC Environment folders can be moved; those outside remain untouched.

   2. Adjust the Run synchronization every (X) hour(s):Sets the frequency of the synchronization. In the GUI, the minimum value is one hour. However, you can use PowerShell to set this to a lower interval.

   3. Modify the Remove machine when absent more than (X) hour(s) setting as needed. Machines not found in the source path after the specified duration will be automatically removed.

Select folders to synchronized

If you want to synchronize only specific folders, such as AVD resource groups, Horizon Desktop Pools or Citrix Delivery Groups, you can do so by changing the settings in the Folders tab:

1. Make sure you are connected to the extension in the console. Navigate to the Folders tab and select the checkboxes of the folders you want to synchronize.

    

2. To sync DNS, site mappings, or folder mappings, follow these steps:

3. Confirm your choices by clicking OK in the Sync popup, then again in the Cloud Connection popup.

4. Right-click the connection mentioned in step 1 and select Sync Folder. A Cloud Connections Sync folder will be created under your organization's folder, containing the synchronized structure of folders and machines from the cloud connections.

    

Sync DNS mappings

AVD

For AVD environments, you can set a default target DNS for all AVD session hosts, regardless of their internal Azure DNS suffix. To set a default target, create a mapping and leave the source suffix blank, before the comma separating it from the target DNS. For example:  ,your.target.dns

You can map the names of folders or FQDN of machines to another DNS suffix. Add a comma as a separator, followed by the DNS.

Rules

• You can enter free text and a wildcard for each mapping pattern. Wildcards can include the following records: 0 or * = Machines and Folders, 1 = Machines only, 2 = Folders only. Both 0 and * records are treated equally.

• You must enter a valid DNS for each mapping pattern.

• If you define several mappings, first enter more specific names, and then more general names.

• If any folder or machine matches multiple DNS mapping records, the more specific name will be applied to it.

Note that if you change a DNS mapping in the Sync popup, it won’t be updated for machines or folders that are already synced in the folder tree. You must first remove existing machines or folders from the tree, right-click the connection from step 1 above, and click Sync Folder to add them with the updated DNS mapping settings.

To configure DNS mappings:

1. Follow step 1 above and click the Mappings tab.

2. In the DNS mappings text box, enter folder or machine mapping patterns as needed. Consider this example:

   

   Line 1 changes the DNS entry for all machines and all folders matching the pattern “Test” to “avdtest.domain”.

   Line 2 changes the DNS entry for all machines and all folders in the folder “scoutbees” to “scoutbees.com”.

3. Click OK in the Sync popup and click OK in the Cloud Connection popup.

4. Right-click the connection from step 1 and click Sync Folder. The folder or machine is added under your Cloud Connections Sync folder:

   

Sync Site mappings

Note

If you change a site mapping in the Sync popup, it won’t be updated for machines or folders that are already synced in the folder tree. You must first remove existing machines or folders from the tree, right-click the connection from step 1 above, and click Sync Folder to add them with the updated site mapping settings.

You can map the names of folders or FQDN of machines to ControlUp Monitor sites. Add a comma as a separator, followed by the name of a ControlUp site.

Rules

• You can enter free text and a wildcard for each mapping pattern. Wildcards can include the following records: 0 or * = Machines and Folders, 1 = Machines only, 2 = Folders only. Both 0 and * records are treated equally.

• You must enter a valid site name for each mapping pattern.

• If you define several mappings, first enter more specific names, and then more general names.

• If any folder or machine matches multiple site mapping records, the more specific name will be applied to it.

To configure Site mappings:

1. Follow step 1 above and click the Mappings tab.

2. In the Site mappings text box, enter folder or machine mapping patterns as needed. Consider this example:

   

   Line 1 places all machines matching the pattern “User/QA” (such as org/User/QA/Ctx-Cloud-01) to the test site.

   Line 2 places all folders in the folder “Cloud Connections” to the test site.

   Line 3 places all machines and all folders matching the pattern “qa-bl*” (such as qa-bl01) the default site.

3. Click OK in the Sync popup and click OK in the Cloud Connection popup.

4. Right-click the connection from step 1 and click Sync Folder. The folder or machine is added under your Cloud Connections Sync folder.

5. To verify that the folders or machines have been added to the site, in the Data Sources tab of the Sites and Monitors - Configuration Wizard, open the site populated with the mapped folders or machines under the Cloud Connections Sync folder.

Sync Folder mappings

From version 9.1, you can map the names of folders or FQDN of machines to a specific folder path, for greater flexibility and better organization to sync folder mappings. Sync folder mappings automatically place your synced machines and folders into specific locations in your organization tree from external AVD or EUC environments.

Use folder mappings for the following tasks:

• Reorganizing imported structures: When the source platform's folder structure doesn't match your required ControlUp organization.

• Consolidating resources: Move machines from multiple sources into unified management folders.

• Environment segregation: Automatically separate production, development, and test resources.

• Compliance requirements: Ensure specific machines are placed in folders with the appropriate security policies.

Folder mappings are a flexible and powerful method to organize synchronized machines according to your organizational needs. By understanding the mapping modes, validation rules, and best practices, you can maintain clean, logical folder structures that enhance management efficiency and support compliance requirements.

Format

Each folder mapping uses the following format: <MappingMode>,<WildcardPattern>,<TargetFolderPath>

After the mapping mode, add a comma as a separator, followed by a wildcard and a folder path.

Important!

If any target folder path specified in a folder mapping doesn’t already exist, the sync will automatically create the target folder in your organization tree.

Mapping Parameters

Mapping Mode (Integer)

• 0 = All (matches both machine names and folder paths)

• 1 = Machines only (matches only machine names)

• 2 = Folders only (matches only folder paths)

Wildcard Pattern (String)

• Pattern to match against machine names or folder paths

• Supports asterisk (*) as wildcard

• Case-insensitive matching

• Can’t be empty

Target Folder Path (String)

• Destination path in your organization tree

• Uses backslash \ as separator

• Must not end with backslash

• Can’t contain any of the following characters: /, :, *, ?, ", <, >, |, {, }

Mapping Modes

Mode 0: All

Matches against both machine names AND their parent folder paths.

Use case: Apply the same redirection rule regardless of whether you are matching a specific machine name pattern or folder structure.

Example: 0,*test*,Organization\Testing\AllTestResources

This example moves any machine with "test" in its name OR any machine in a folder containing "test" to the specified location.

Mode 1: ComputersOnly

Matches only against machine names.

Use case: Redirect specific machines based on naming conventions, regardless of their source folder.

Example:

1,WEB-*,Organization\WebServers
1,DB-*,Organization\DatabaseServers
1,*-PRD-*,Organization\Production\Servers

Mode 1:  FoldersOnly

Matches against the parent folder path of the machine.

Use case: Redirect all machines from specific source folders/pools/resource groups.

Example:

2,*ProductionPool*,Organization\Production\VDI
2,*DevHostPool*,Organization\Development\VirtualDesktops
2,*/ResourceGroups/RG-HR-*,Organization\Departments\HumanResources

Processing Order and Behavior

1. First Match Wins: Mappings are processed in the order they appear. Once a match is found, processing stops.

2. Original Structure Preservation: When using FoldersOnly mode, the system maintains folder hierarchy below the matched point.

3. Override Behavior: Mapped paths completely override the default synchronization path.

Validation Rules

Note

If you change a folder mapping in the Sync popup, it won’t be updated for machines or folders that are already synced in the folder tree. You must first remove existing machines or folders from the tree, right-click the connection from step 1 above, and click Sync Folder to add them with the updated folder mapping settings.

Required Validations

• Each mapping must have exactly 3 parameters.

• Mapping Mode must be 0/*, 1, or 2 (0/* = Machines and Folders, 1 = Machines only, 2 = Folders only.)

• Wildcard Pattern can’t be empty.

• Target Folder Path can’t be empty

• Target Folder Path can’t end with backslash

• Target Folder Path can’t contain forbidden characters

Common Validation Errors

Error: "Invalid folder mapping"

• Cause: Incorrect number of parameters

• Solution: Ensure each line has exactly 3 comma-separated values

Error: "Invalid sync mode"

• Cause: MappingMode is not 0, 1, or 2

• Solution: Use only valid mode values

Error: "Path contains invalid characters"

• Cause: Using forbidden characters in the path

• Solution: Remove characters such as /, :, *, ?, ", <, >, |, {, }

Best Practices

• Order mappings from specific to general, for example:

1,WEB-PRD-01,Organization\Critical\WebServers
1,WEB-PRD-*,Organization\Production\WebServers
1,WEB-*,Organization\WebServers

• Use consistent naming conventions:

  • Establish clear naming patterns in source systems

  • Document your mapping strategy

  • First test mappings in non-production environments

• Avoid overlapping patterns

  Instead of:

1,*-PROD-*,Organization\Production
1,WEB-PROD-*,Organization\WebServers

Use:

1,WEB-PROD-*,Organization\Production\WebServers
1,*-PROD-*,Organization\Production\Other

• Regular review and maintenance:

  • Periodically review mappings for relevance

  • Remove obsolete mappings

  • Update mappings when naming conventions change

Configure Sync Folder Mappings

To configure sync folder mappings:

1. Follow step 1 above and click the Mappings tab.

2. In the Folder mappings text box, enter folder or machine mapping patterns as needed. Consider this example:

   

   Line 1 places all machines matching the pattern “CVAD*” to the folder path “myOrgName\Citrix\Mgmt”.

   Line 2 places all machines matching the pattern “PVS22-0*” to the folder path “myOrgName\Citrix\Pooled_VDAs”.

   Line 3 places all machines matching the pattern “W11VDA*” to the folder path “myOrgName\Citrix\Personal\VDAs”.

3. Click OK in the Sync popup and click OK in the Cloud Connection popup.

4. Right-click the connection from step 1 and click Sync Folder. The folder or machine is added to the new folder path under your Cloud Connections Sync folder. All machines under the same delivery group (Citrix), resource group (AVD), or desktop pool (Horizon) will be synced to this folder.

Sync Folder mapping examples

Map AVD machines or folders to same folder in root of organization

Line 1 places all machines and all folders matching the pattern “AVD_pooled” to a folder path in the root of your organization tree.

Map different machines to different folders

Line 1 places all machines matching the pattern “hz23” to the folder path “qaorg v4 9-1\test1”.

Line 2 places all machines matching the pattern “hv23” to the folder path “qaorg v4 9-1\test2”.

Map different machines or folders to different folders

Line 1 places all machines and all folders matching the pattern “hz23” to the folder path “qaorg v4 9-1\test1”.

Line 2 places all folders matching the pattern “hv23” to the folder path “qaorg v4 9-1\test2”.

Sync Folder Mappings Troubleshooting

To troubleshoot folder mapping issues, enable debug logging for the sync operations:

Log4net Configuration

Add the following logger to your log4net configuration:

<logger name="SmartX.ControlUp.Client.FolderTreeSync">
   <level value="DEBUG"/>
   <appender-ref ref="RollingFileAppender"/>
</logger>

With debug logging enabled, the logs will show the following:

Folder Mapping Application

• "Applying next folder mappings: Mode: [mode], Wildcard: "[wildcard]", Path: "[path]"" (for each configured mapping)

• "Folder mapping "[mode],[wildcard],[path]" is matched with Machine "[name]" by machine name. (New projected path: "[path]")." (for ComputersOnly matches)

• "Folder mapping "[mode],[wildcard],[path]" is matched with Machine "[name]" by folder path. (Old projected path: "[old]", New projected path: "[new]")." (for FoldersOnly matches)

• "Folder mapping "[mode],[wildcard],[path]" is not matched with Machine "[name]" (Projected path: "[path]")." (when no match)

Common Mistakes

• Using forward slashes: Always use a backslash (\) in folder paths.

• Trailing backslashes: Remove any backslash at the end of paths.

• Case sensitivity assumption: Patterns are case-insensitive.

• Multiple wildcard usage: Keep patterns simple.

• Not checking logs: Debug logs provide exact details of why mappings did or didn't match.

Sync non-domain joined AVD machines

To sync non-domain joined AVD machines with your folders:

1. Right-click on a connection under your organization folder, select Add, and click Cloud Connection.

2. Enter the Tenant ID, select the Credentials of the non-domain joined AVD machine you want to join, and click Add.

3. Select a machine to add as a data collection agent:

   

4. Click OK in the Add data collection popup and click OK in the Cloud Connection window.

5. The Cloud Connection popup confirms the discovery of one Azure subscription, click OK in the Sync window and click OK in the Cloud Connection window. The new cloud connection appears under your Cloud Connections folder.

6. To verify that all child folders have been added, after the new cloud connection connects, right-click on it, select Connection Settings, click Edit Sync Options, and click the Folders tab. The connection is populated with the child folders:

   

7. Click OK in the Sync window, click OK in the Cloud Connection window, right-click the connection from step 1 above, and select Sync Folder. The Cloud Connections Sync folder is populated with the non-domain joined AVD machine showing the DNS suffix:

   

Change Synchronization Interval via PowerShell

The console allows setting the synchronization interval to a minimum of one hour. If you require more frequent synchronization for your AVD or EUC environments, this can be accomplished using the Set-EUCSyncConfig cmdlet.

1. Log in to one of your ControlUp monitors and open a PowerShell prompt.

2. Import the ControlUp PowerShell User module by running the following cmdlets:
   $pathToUserModule = (Get-ChildItem "C:\Program Files\Smart-X\ControlUpMonitor\*ControlUp.PowerShell.User.dll" -Recurse | Sort-Object LastWriteTime -Descending | Select-Object -First 1).FullName

   Import-Module $pathToUserModule

3. Execute Get-EUCSyncConfig to review your current sync configuration.

4. Identify and copy the ExtensionObjectId of the extension you like to configure.

5. Use the copied ObjectGuid in the following cmdlet, setting the Interval to your desired value in minutes (minimum value is 5 minutes):
   Set-EUCSyncConfig -ObjectGuid "e2ca240f-6f15-4c55-9e72-55b0c262ee0d" -Interval 5

6. Wait approximately one minute, then open the Sync Config in the console to verify the update. The Interval value should now be grayed out.

   Note

   After modifying the interval via PowerShell, any subsequent changes must also be made through PowerShell.