Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
NileshGhodekar committed Jan 30, 2019
2 parents 978b4e6 + 8727e03 commit 9a95328
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The current capabilities of the tool include:

* Documentation of the complete configuration of Azure AD Connect sync.
* Documentation of any changes in the configuration of two Azure AD 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.
* Generation of the PowerShell deployment script to migrate the sync rule differences or customizations from one server to another.

![Sample Report](https://github.com/Microsoft/AADConnectConfigDocumenter/wiki/Sample-Report-ToC-Contoso-Header.jpg)

Expand All @@ -25,11 +25,11 @@ Prerequisites:

How to use the tool:

* Download the latest release AzureADConnectSyncDocumenter.zip from the [**releases**](https://github.com/Microsoft/AADConnectConfigDocumenter/releases) tab under the Code tab tab.
* Download the latest release AzureADConnectSyncDocumenter.zip from the [**releases**](https://github.com/Microsoft/AADConnectConfigDocumenter/releases) tab under the Code tab.
* UNBLOCK the downloaded zip file using the **Right Click** | **Properties** menu and then checking the **Unblock** check-box from the **General** tab.
* 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-Contoso.cmd.
* Make sure that the tool runs by double-clicking on the .cmd file AzureADConnectSyncDocumenter-Contoso.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.

```PowerShell
Expand All @@ -43,9 +43,9 @@ How to use the tool:
* e.g. the "Pilot" configuration files for the customer "Contoso" are provided as a sample under the "Data\Contoso\Pilot" folder. This is the folder where the files of the ***to be*** or ***end-state*** configuration are located. So, for example, in a swing migration project the "Pilot" or "Target" configuration will be the configuration of the "old" server, since the goal is to build a new server with the configuration as close to the old server as possible.
* If you want to document the changes from a specific baseline, export the server configuration of your baseline / production Azure AD Connect server and copy the output to a folder under the Documenter "Data" directory.
* e.g. the "Production" configuration files for the customer "Contoso" are provided as a sample under the "Data\Contoso\Production" folder. This is the folder where the files of the ***as-is*** or ***baseline*** configuration are located.
* Make a copy of AzureADConnectSyncDocumenter-Contoso.cmd with a name appropriate for your enviroment (say AzureADConnectSyncDocumenter-Fabrikam.cmd) and edit your copy for the values of "Pilot" and "Production" directories.
* Make a copy of AzureADConnectSyncDocumenter-Contoso.cmd with a name appropriate for your environment (say AzureADConnectSyncDocumenter-Fabrikam.cmd) and edit your copy for the values of "Pilot" and "Production" directories.
* If you don't have a baseline / production config, specify the same path as the "Pilot" config.
* Run your updated updated batch file. Upon successful execution, the generated report will be found in the Documenter "Report" folder.
* Run your updated batch file. Upon successful execution, the generated report will be found in the Documenter "Report" folder.

**!!NOTE!!** _**If the name(s) of the connector(s) do(es) not exactly match between the supplied "Pilot" and "Production" configuration files, then before running the tool, "prep" the exported config files by manually editing the xml files located in the "Connectors" folder so that the name of the connector(s) match. The name of the connector is located inside the "name" element at the start of the content.**_

Expand Down

0 comments on commit 9a95328

Please sign in to comment.