How to install the Directory Synchronization tool on SQL Server 2008

  • Article

 

Applies to: Office 365 Enterprise

This topic describes how to install the Azure Active Directory Sync tool for Office 365 onto a computer that is running SQL Server 2008 R2.

Note

Installing the Directory Sync tool on SQL Server 2012 is not yet supported.

By default, the Directory Sync tool in Office 365 comes with SQL Server 2008 Express. It has (object) size limitations that you should consider if you have a large organization.

We recommend running directory synchronization on a full installation of SQL Server 2008 R2 if you will be synchronizing more than 50,000 objects. To determine how many objects your organization will be synchronizing, run the checks in OnRamp for Office 365.

If you determine that running the Directory Sync tool on a full installation of SQL Server is a requirement for your organization, use the following steps. Otherwise, install the default version of the Directory Sync tool by using the Prepare to install Directory Synchronization tool topic.

Follow these steps to install the Directory Sync tool on a full installation of SQL Server:

-
Step 1: Download the Directory Synchronization tool

-
Step 2: Install the Directory Synchronization tool

-
Step 3: Configure the Directory Synchronization tool

-
Step 4: Synchronize your directories

-
Step 5: Specify parameter options for the Install-OnlineCoexistenceTool cmdlet

Step 1: Download the Directory Sync tool

  1. Sign in to the Office 365 portal.

  2. In the header, click Admin. On the Admin page, click Users.

  3. On the Users page, next to Active Directory synchronization, click Set up.

  4. On the Set up and manage Active Directory synchronization page, under step 4, click Download.

Step 2: Install the Directory Sync tool

The administrative credentials that are used to perform this installation must have rights within SQL Server to create the directory synchronization database.

  1. If you intend to install the Directory Sync tool to communicate with a remote installation of SQL Server, you will need to install the SQL Native Client application before you proceed. For more information, see SQL Server Native Client Programming.

  2. At the command prompt, navigate to the folder where you downloaded the Directory Sync tool, and then type dirsync /fullsql

  3. If a User Account Control dialog box is displayed, click Continue, or type the user name and password of an administrator account, and then click OK.

  4. On the Welcome page, click Next.

  5. On the Microsoft Software License Terms page, read the license terms, select I accept the Microsoft Software License Terms, and then click Next.

  6. On the Select Installation Folder page, select an installation folder location, and then click Next.

  7. On the Installation page, wait for the installation to complete, and then click Next.

  8. On the Finished page, click Finish.

Step 3: Configure the Directory Sync tool

  1. On the computer where the Directory Sync tool was installed, navigate to \Program Files\Microsoft Online Directory Sync, and then double-click DirsyncInstallShell.psc1

  2. At the Windows PowerShell prompt, do only one of the four following methods:

    • To install the Directory Sync tool on the same computer that has SQL Server 2008 R2, type:

      Install-OnlineCoexistenceTool -UseSQLServer -Verbose

    • To install the Directory Sync tool by using a remote installation of SQL Server 2008 R2, type

      Install-OnlineCoexistenceTool -UseSQLServer -SqlServer <SQLServerName> -ServiceCredential (Get-Credential) -Verbose

    • To install the Directory Sync tool by specifying the installation of SQL Server, add the -SqlServerInstance parameter. For example, run a command that resembles the following:

      Install-OnlineCoexistenceTool -UseSQLServer -SqlServer <SQLServerName> -ServiceCredential (Get-Credential) -SqlServerInstance <SqlInstanceName>

      Note

      If you are installing the Directory Sync tool to the default instance of SQL Server on the remote server that is running SQL Server, don’t use the -SQLInstance parameter in the preceding statement.

  3. At the Windows PowerShell Credential Request prompt, type the user name and password of the domain account that will be used to run the Forefront Identity Manager Synchronization service and the Office 365 Directory Synchronization service.

  4. Run the Azure Active Directory Sync Tool Configuration Wizard to complete the configuration. By the default, the Directory Synchronization Configuration Wizard (ConfigWizard.exe) is installed to \Program Files\Microsoft Online Directory Sync.

Step 4: Synchronize your directories

See Synchronize your directories.

Step 5: Specify parameter options for the Install-OnlineCoexistenceTool cmdlet

  • -ServiceCredential <PSCredential>

    The credential to be assigned to the Forefront Identity Manager Synchronization service. When this parameter is not specified, an MIIS_Service account will be created on the local computer. The credential is also used by the Office 365 Directory Synchronization Service.

  • -UseSQLServer

    This flag causes the installation to not install SQL Server Express. Use this flag with one or both of the following parameters: SqlServer, SqlServerInstance.

  • -InstallPath <String>

    This optional parameter specifies the path to the folder that contains the files to be installed. These files include the SQL Server Express Setup program (SQLEXPR32_x86_ENU.exe), Microsoft Identity Integration Server.msi< and the DirectorySync.msi files.

  • -SqlServerInstance <String>

    The name of the instance of SQL Server that Forefront Identity Manager will use.

  • -SqlServer <String>

    The name of the server that is hosting SQL Server for Forefront Identity Manager.