Install and prepare GCDS

Optional: Update GCDS

If you're using an older version of Google Cloud Directory Sync (GCDS), you might not be getting the most from the tool.

Google occasionally releases new versions of GCDS. We recommend installing the latest version to make sure you have the most recent features and fixes. To review additions and improvements to the most recent versions of GCDS, see What's new in Google Cloud Directory Sync.

Note: Google Cloud Support only provides help with issues found in the latest version of GCDS.

There are two options when updating GCDS. Most customers can update their GCDS setup in-place. However, if your organization requires you to keep your existing setup running, while you configure and test the latest version, you can follow the side-by-side update instructions below.

New GCDS versions typically don't impact the results of an existing sync. However, in some cases you might see changes so you should always make sure your configuration is correct.

GCDS in-place update

To update your existing GCDS setup, follow these steps:

  1. Perform a manual GCDS sync so you have fewer changes to review after the update. Learn more 
  2. Download the correct GCDS version for your platform:
  3. Open the installer and follow the instructions to install GCDS.

    If you're installing it on the same machine as the current GCDS installation, the installer should detect GCDS is already installed and suggest an upgrade.

  4. After you install GCDS, start the GCDS Configuration Manager.
    1. Select File > Open to load your existing XML configuration file.
    2. Review the configuration file settings and save it.

      Note: You won't be able to run a synchronization until the XML configuration file has been saved using the updated GCDS version.

  5. Run a synchronization simulation and review the proposed changes. Learn more

    If any undesired changes are listed, review your configuration, make corrections, and save the XML file.

  6. If you use a utility like a scheduled task or cron job to run GCDS, trigger the job scheduler manually to ensure the sync works as expected.

    This is especially important if the job scheduler utility runs under a different system user from the one used to configure GCDS.

GCDS side-by-side update

To install another version of GCDS, follow these steps:

  1. Perform a manual GCDS sync so you have fewer changes to review after the update. Learn more
  2. Download the correct GCDS version for your platform:
  3. Open the installer and follow the instructions to install GCDS.
    1. If you're installing it on the same machine as the current GCDS installation, the installer should detect GCDS is already installed and suggest an upgrade.. 
    2. Select No, install into a different directory to install the new version in a different location, without removing the existing version.
  4. After you install GCDS, start the GCDS Configuration Manager.
    1. Verify you're using the new GCDS version by selecting Help > About Google Cloud Directory Sync.
    2. Select File > Open to load your existing XML configuration file.
    3. Review the configuration file settings and save it with a new name to create a copy for this new GCDS version.

      Note: You won't be able to run a synchronization until the XML configuration file has been saved using the new GCDS version.

  5. Run a synchronization simulation and review the proposed changes. Learn more

    If any undesired changes are listed, review your configuration, make corrections, and save the XML file.

    Note: To ensure GCDS sees the entire G Suite directory, select Clear cache when running a synchronization simulation.

  6. If you use a utility like a scheduled task or cron job to run GCDS, update it to use the new version and then trigger the job scheduler manually to ensure the sync works as expected.

    This is especially important if the job scheduler utility runs under a different system user from the one used to configure GCDS.

  7. To prevent undesired changes due to an outdated configuration file, make sure the previous version's configuration file is disabled. For example, rename the XML file from sync.xml to sync-DISABLED.xml.
  8. Once you're sure the new version is operating as expected, uninstall the previous version to prevent confusion.

Related topics

What's new in Google Cloud Directory Sync

Was this helpful?
How can we improve it?