export-ldif

Description

Export data from a Directory Server backend in LDIF format.

To export data from a remote Directory Server, the Directory Server 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 Directory Server'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.

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 --backendID userRoot --ldifFile userRoot.ldif.gz.encrypted \
     --encryptLDIF --sign --compress

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}

-T {truststorePassword}
--trustStorePassword {truststorePassword}

-U {path}
--trustStorePasswordFile {path}

-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}

--startAlert

--successAlert

--errorAlert

--startNotify {emailAddress}

--completionNotify {emailAddress}

--successNotify {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

--maxMegabytesPerSecond {MB}

-y
--encryptLDIF

--promptForEncryptionPassphrase

--encryptionPassphraseFile {path}

--encryptionSettingsDefinitionID {path}

--doNotEncrypt

-s
--sign

--logFilePath {logFilePath}