How To
ForgeRock Identity Platform
Does not apply to Identity Cloud

How do I restore DS 5.x or 6.x from another DS instance?

Last updated Apr 8, 2021

The purpose of this article is to provide information on rebuilding DS using data from another DS server. It is always preferable to restore DS from a backup, but you can use this approach if the server you want to restore does not have a current backup and the restore happens within the changelog purge delay window (default 3 days).


DS 7 introduces a simplified backup and restore implementation. See Maintenance Guide › Disaster Recovery for further information.

In earlier versions, you should follow the steps in the Rebuilding DS (pre-DS 7) section.

Rebuilding DS (pre-DS 7)

You can rebuild a DS server (server1) using data from another DS server (server2) as follows:

  1. Create a backup of the good server (server2) using the backup command, for example: $ ./backup --hostname --port 4444 --bindDN "cn=Directory Manager" --bindPassword password --backUpAll --backupDirectory /path/to/ds/bak --start 0
  2. Copy the backup file(s) to the server you want to rebuild (server1).
  3. Stop the server you are rebuilding (server1).
  4. Restore the data to the server using the restore command. Each backend needs to be restored individually using a separate restore command, where you specify the backend to restore as part of the path. This example shows the userRoot backend being restored (needs the --offline option when the server is stopped): $ ./restore --offline --backupID 20161019102414Z --backupDirectory /path/to/ds/bak/userRoot
  5. Start the server.

See Also

FAQ: Backup and restore in DS 5.x and 6.x

How do I design and implement my backup and restore strategies for DS (All versions)?

How do I restore old backup data to a DS 5.x or 6.x replication topology?

How do I roll back an entire network of DS 5.x or 6.x replicas to a previous backup?

How do I control how long replication changes are retained in DS (All versions)?

Administration Guide › Backing Up Directory Data

Administration Guide › Restoring Directory Data From Backup

Related Training


Related Issue Tracker IDs


Copyright and Trademarks Copyright © 2021 ForgeRock, all rights reserved.