The PingDirectory server export-ldif command line tool exports data from the server backend to an LDIF file for backups, exporting data to other applications, or reinitializing servers in a replicated topology.
The export-ldif tool supports the --task
argument,
which initiates the export process from within the PingDirectory server. When export-ldif is run
as a task, extra information is available:
- Output from the export process is included in the error log.
- There is a task entry (accessible below the
cn=tasks
base distinguished name (DN)) with information about the success or failure of the export along with log messages.
An ldif-export task can be run from the server system or a remote system. Even if it's run from a remote system, the exported LDIF file is still written to the server system.
The export-ldif tool exports a point-in-time snapshot of the backend that is guaranteed to provide a consistent state of the database in LDIF. If necessary, you can re-import with import-ldif. The data exported by export-ldif can include all or some of the entries (a subset of the entries, or a subset of the attributes within entries, or both) contained in the backend. You accomplish this by specifying branches, filters, and attributes to include or exclude. You can compress, encrypt, or digitally sign the exported LDIF.
You can configure LDIF exports as recurring tasks with dsconfig create-recurring-task. You can schedule them to run by adding them to a recurring task chain.