Active Directory Synchronization Tool

Administrator -


The AD Sync Tool enables to import your Active Directory users into your XMedius cloud platform – and to subsequently synchronize (i.e. update/delete) these users on your XMedius cloud platform according to the changes that may occur in your Active Directory user database.

The AD Sync tool is provided in the form of a Python script (and modules) and is intended to be executed from your network.


Version: 1.1.15

AD Sync Tool – zip (1 MB)

  • MD5: 64F5F50E61CC598C8099348E61E69D9D
  • SHA1: 4E7917331654CE68C7732FA2C18B97FB9D775CA8


  • An XMedius Cloud account is required to use the AD Sync Tool.
  • The computer hosting the AD Sync Tool must meet the following requirements:
    • Run Windows 7+ or Windows Server 2012+.
    • Have network access to your Active Directory server with permissions to perform queries to the Active Directory LDAP interface (LDAP, 389 by default).
    • Have internet access with permissions to perform outbound TCP connections to your XMedius Cloud Enterprise Account (https, port 443).
    • Have Python 3.7.x32-bit version – installed.

      To get Python, go to – pay attention to the specifications of the selected package before downloading: version (only 3.7.x), operating system (Windows) and bitness (only x86, i.e. not 64).

Installation/Update Instructions

First Installation/Configuration

  1. Ensure that the computer that is going to host the AD Sync Tool meets all Requirements.
  2. Download the latest version of the AD Sync package file provided above in the Download section.
  3. Decompress the file in the folder or your choice (further referenced as <adsync_home> in configuration steps).
  4. Prepare your environment and configure the AD Sync tool according to the instructions provided in the following article: Synchronizing Users from Active Directory


  1. Backup all configuration files (located in <adsync_home>/config) to a temporary folder.
  2. If you previously customized the file <addync_home>/libs/http/, Backup this file as well to a temporary folder.
  3. Decompress the zip file to the <adsync_home> folder, overwrite all the files.
  4. Restore the configuration files copied in step 1.
  5. Restore the file copied in step 2.

If you need to perform further configurations after updating the AD Sync tool, see the article referenced above.

Change History

Version Release Date Summary
1.1.15 2020-01-16
  • The AD Sync Tool now attempts to reconnect to the LADP server if the connection was lost.
1.1.14 2019-12-19
  • Fixed a memory leak when running the AD sync Tool.
  • Fixed the issue where the AD Sync Tool may fail and corrupt the database with an invalid USN value.
1.1.10 2019-10-07
  • Fixed the issue where the AD Sync Tool may fail to delete users from the XMedius cloud platform.
1.1.3 2019-05-30
  • The AD Sync Tool has been updated to run with Python 3.7 (which is now the minimum required Python version).
  • The AD Sync Tool now supports LDAPS for Active Directory connection/authentication, including a new option to validate the LDAP server certificate.
  • Other minor improvements and fixes.
1.0.5 2017-09-19
  • The AD Sync Tool now tries to re-process all entries that were not successfully synchronized during the previous script execution.
  • The Country attribute of AD users can now be properly synchronized to the portal.

    Note that existing AD Sync configuration file needs to be manually updated in addition to the fix: in attributes_mapping, change the country value from "co" to "c".

  • The DistinguishedNameExtractor has been improved to properly parse the DN if the OU contains an escaped comma.
  • Other minor improvements and fixes.
1.0.4 2015-08-07
  • The AD Sync Tool can now be configured to disable automatic sending of password setup emails to newly created users
1.0.1 2014-02-12
  • Initial Public Release
Have more questions? Submit a request


Powered by Zendesk