Exporting data
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 |
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 |
Performing an export
Export data to an LDIF file.
Steps
-
To export data to an LDIF file, run the
export-ldif
tool.Example:
$ bin/export-ldif --backendID userRoot --ldifFile userRoot.ldif
Performing an export from specific branches
Steps
-
To export data to an LDIF file under a specific branch from the userRoot backend of the local PingDirectory server into a compressed file, run the
export-ldif
tool.Example:
In addition to including a specific branch, the following command excludes operational attributes from the exported data and wraps long lines at column 80.
$ bin/export-ldif --backendID userRoot --ldifFile userRoot.ldif.gz --compress \ --includeBranch ou=people,dc=example,dc=com --excludeOperational \ --wrapColumn 80