export-ldif

Description

Export data from an Identity Data Store backend in LDIF format.

To export data from a remote Identity Data Store, the Identity Data Store must be running and connection parameters must be supplied. You can specify options to include or exclude specific attributes and branches of the tree, and to include or exclude entries matching a given filter. The data may be appended to an existing file instead of overwriting it, and the output may be optionally compressed.

This tool features both an offline mode of operation as well as the ability to schedule an operation to run within the Identity Data Store's process. To schedule an operation supply LDAP connection options that allow this tool to communicate with the server through its task interface. Tasks can be scheduled to run immediately or at a later time (see Task Scheduling Options below). Once scheduled, tasks can be managed using the manage-tasks tool.

WARNING: Processing an LDIF export as a task does not provide any assurance that the resulting LDIF file represents any specific point in time. Some of the entries written to the LDIF file may include changes processed after the LDIF export was started, which may cause difficulty in attempts to import the LDIF file and/or re-synchronize the data with other servers in the replication topology. It is strongly recommended that LDIF exports of local DB backends be performed using the export-ldif tool in non-task mode, which guarantees that the resulting LDIF file will represent the state of the data as it appeared at the time the export was started and will not include any changes made to the data while the export is in progress.

Examples

export-ldif --backendID userRoot --ldifFile userRoot.ldif

export-ldif --backendID userRoot --ldifFile userRoot.ldif.gz --compress \
     --includeBranch ou=people,dc=example,dc=com --excludeOperational \
     --wrapColumn 80

export-ldif --task --hostname server1 --port 389 \
     --bindDN uid=admin,dc=example,dc=com --bindPassword password \
     --backendID userRoot --ldifFile userRoot.ldif

Arguments

-V
--version

-H
--help

--help-ldap

--help-sasl

--help-debug

-Z
--useSSL

-q
--useStartTLS

--useNoSecurity

-h {host}
--hostname {host}

-p {port}
--port {port}

-D {bindDN}
--bindDN {bindDN}

-w {bindPassword}
--bindPassword {bindPassword}

-j {bindPasswordFile}
--bindPasswordFile {bindPasswordFile}

-o {name=value}
--saslOption {name=value}

-X
--trustAll

-P {trustStorePath}
--trustStorePath {trustStorePath}

-K {keyStorePath}
--keyStorePath {keyStorePath}

-W {keyStorePassword}
--keyStorePassword {keyStorePassword}

-u {keyStorePasswordFile}
--keyStorePasswordFile {keyStorePasswordFile}

-N {nickname}
--certNickname {nickname}

--useAdministrativeSession

--propertiesFilePath {propertiesFilePath}

--usePropertiesFile

--script-friendly

--task

-t {startTime}
--start {startTime}

--completionNotify {emailAddress}

--errorNotify {emailAddress}

--dependency {taskID}

--failedDependencyAction {action}

-Q
--quiet

-l {ldifFile}
--ldifFile {ldifFile}

-a
--appendToLDIF

-n {backendName}
--backendID {backendName}

-b {branchDN}
--includeBranch {branchDN}

-B {branchDN}
--excludeBranch {branchDN}

-i {attribute}
--includeAttribute {attribute}

-e {attribute}
--excludeAttribute {attribute}

-I {filter}
--includeFilter {filter}

-E {filter}
--excludeFilter {filter}

-O
--excludeOperational

-R
--excludeReplication

-S
--excludeSoftDelete

--wrapColumn {wrapColumn}

-c
--compress

-y
--encryptLDIF

-s
--sign

--logFilePath {logFilePath}