There are two Microsoft Entra Connect servers in the organization. One of them is active, and the other is in staging mode. That’s because you should always have one active and not more. We like to compare if the configuration is the same. So we don’t get any issues if we have to enable the staging server in the future. In this article, you will learn how to compare Microsoft Entra Connect configuration between servers.
Table of contents
- Microsoft Entra Connect Configuration Documenter
- Step 1. Download Microsoft Entra Connect Configuration Documenter tool
- Step 2. Verify Microsoft Entra Connect Configuration Documenter tool
- Step 3. Export PROD Microsoft Entra Connect server configuration
- Step 4. Export NON-PROD Microsoft Entra Connect server configuration
- Step 5. Create Microsoft Entra Connect server configuration comparison report
- Conclusion
Microsoft Entra Connect Configuration Documenter
Microsoft Entra Connect configuration documenter is a tool to generate documentation of a Microsoft Entra Connect installation.
The current capabilities of the tool include:
- Documentation of the complete configuration of Microsoft Entra Connect sync.
- Documentation of any changes in the configuration of two Microsoft Entra Connect sync servers or changes from a given configuration baseline.
- Generation of the PowerShell deployment script to migrate the sync rule differences or customisations from one server to another.
Note: Microsoft Entra Connect must be installed and configured on the Windows Server as a prerequisite. Otherwise, you won’t be able to use the configuration documenter tool.
Step 1. Download Microsoft Entra Connect Configuration Documenter tool
- Sign in to the production Microsoft Entra Connect server
- Download the Microsoft Entra Connect configuration documenter tool (direct link) or GitHub
- Right-click the .zip file and select Properties


- Select Unblock and click OK


- Extract the files in the .zip to the folder C:\Scripts so it looks like the screen below


Step 2. Verify Microsoft Entra Connect Configuration Documenter tool
- Sign in to the production Microsoft Entra Connect server
- Open the AzureADConnectSyncDocumenter folder
- Run the cmd file AzureADConnectSyncDocumenter.cmd


- Press any key to close the screen


- Open the AADConnectSyncDocumenter-Error.log file


- Check that it’s empty and that there are no errors present


- Verify that the generated report Contoso is created under the folder Report


Note: This is just a demo and a test to see if the tool works. If you can see the report, everything is okay, and you can proceed further. If not, return and ensure that this works.
- Open the report


Step 3. Export PROD Microsoft Entra Connect server configuration
- Sign in to the production Microsoft Entra Connect server
- Run PowerShell as an administrator
- Run the commands below
Import-Module ADSync
Get-ADSyncServerConfiguration -Path "C:\Temp\MEC-DC01-PROD"
- Go to the Temp folder to find the exported configuration folder


Step 4. Export NON-PROD Microsoft Entra Connect server configuration
- Sign in to the non-production (staging) Microsoft Entra Connect server
- Run PowerShell as an administrator
- Run the commands below
Import-Module ADSync
Get-ADSyncServerConfiguration -Path "C:\Temp\MEC-DC02-NON-PROD"
- Go to the Temp folder to find the exported configuration folder


Step 5. Create Microsoft Entra Connect server configuration comparison report
- Sign in to the production or non-production server. This does not matter because you only want to create a comparison configuration report.
- Start File Explorer and go to the following path
C:\Scripts\AzureADConnectSyncDocumenter\Data
- Copy both the configuration folders from the previous step to the Data folder


- Run PowerShell as an administrator
- Change the path to the Microsoft Entra Connect Configuration Documenter tool
cd C:\Scripts\AzureADConnectSyncDocumenter\
- Run the command below to create the config comparison report between both Entra Connect servers
.\AzureADConnectSyncDocumenterCmd.exe "MEC-DC02-NON-PROD" "MEC-DC01-PROD"
- Go to the Report folder
- Open the report


- Check the checkbox Only show Changes
- Verify that the Target/Pilot Config is the non-production server
- Verify that the Reference/Production Config is the production server


- Go through the configuration comparison report


That’s it!
Read more: How to find Microsoft Entra Connect accounts »
Conclusion
You learned how to compare Microsoft Entra Connect configuration. The tool creates a beautiful report where you can find all the information about the Entra Connect config. It’s a great way to compare Entra Connect server configurations so you don’t make any mistakes when it comes to syncing your on-premises objects to Microsoft 365.
Did you enjoy this article? You may also like How to upgrade Microsoft Entra Connect. Don’t forget to follow us and share this article.

