Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
NileshGhodekar committed Jun 3, 2016
2 parents cf48c9f + bf90a51 commit 295b166
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
@@ -1,21 +1,21 @@
# Azure AD Connect Configuration Documenter

AAD Connect configuration documenter is a tool to generate documentation of an Azure AD Connect Connect installation. Currently, the documentation is only limited to the Azure AD Connect sync configuration.
AAD Connect configuration documenter is a tool to generate documentation of an Azure AD Connect installation. Currently, the documentation is only limited to the Azure AD Connect sync configuration.

The goal of this project is to:

* To enable quick understanding of the synchronisation configuration and "how it happens"!
* To enable quick understanding of the synchronization configuration and "how it happens"!
* To build confidence in getting things right when making changes to the default configuration!!
* To know what was changed when you applied a new build of Azure AD Connect!!!
* To know what was changed when you applied a new build / configuration of Azure AD Connect or added/udpated custom sync rules!!!

Prerequisites:

1. .NET Framework 4.5 to be able to run the tool
2. A fair understanding of MIIS 2003 / ILM 2007 / FIM 2010 / MIM 2016 sync engine technical concepts to be able to understand the report.
2. A fair understanding of MIIS 2003 / ILM 2007 / FIM 2010 / MIM 2016 sync engine technical concepts to be able to understand the report. A sample report generated by the tool can be found listed in the [Wiki](https://github.com/Microsoft/AADConnectConfigDocumenter/wiki/Sample-Report) section.

How to use the tool:

* Download the latest release from the [releases](https://github.com/Microsoft/MIMWAL/releases) tab under the Code tab tab and extract the zip file to an empty local folder on a machine which has .NET Framework 4.5 installed.
* Download the latest release from the [releases](https://github.com/Microsoft/AADConnectConfigDocumenter/releases) tab under the Code tab tab, UNBLOCK the downloaded zip file and extract the zip file to an empty local folder on a machine which has .NET Framework 4.5 installed.
* This will extract the Documenter application binaries along with the sample data files for "Contoso".
* Make sure that the tool runs by double-clicking on the cmd file AzureADConnectSyncDocumenter.cmd.
* Export the Server Configuration of your pilot / test Azure AD Connect sync server by running Get-ADSyncServerConfiguration cmdlet defined in ADSync module shipped with Azure AD Connect.
Expand All @@ -35,4 +35,6 @@ How to use the tool:
* If you don't have a baseline / production config, specify the same path as the "Pilot" config.
* Run the updated batch file. Upon successful execution, the generated report will be found in the Documenter "Report" folder.

A sample report generated by the tool can be found listed in the [Wiki](https://github.com/Microsoft/AADConnectConfigDocumenter/wiki/Sample-Report) section.

[https://aka.ms/aadConnectConfigDocumenter](https://aka.ms/aadconnectconfigdocumenter)

0 comments on commit 295b166

Please sign in to comment.