Title: export-ldif
Author:
Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
Date: January 03, 2012
Manual: Tools Reference
Source: OpenDJ 2.5.0
Language: English
* Define some portability stuff
-----------------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
http://bugs.debian.org/507673
http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-----------------------------------------------------------------
* set default formatting
-----------------------------------------------------------------
disable hyphenation
disable justification (adjust text to left margin only)
-----------------------------------------------------------------
* MAIN CONTENT STARTS HERE *
-----------------------------------------------------------------
\w'export-ldif 'u export-ldif {options}
This utility can be used to export data from a directory server backend in LDIF form.
The following options are supported.
-a, --appendToLDIF
Append an existing LDIF file rather than overwriting it.
-b, --includeBranch {branchDN}
Base DN of a branch to include in the LDIF export.
-B, --excludeBranch {branchDN}
Base DN of a branch to exclude from the LDIF export.
-c, --compress
Compress the LDIF data as it is exported.
-e, --excludeAttribute {attribute}
Attribute to exclude from the LDIF export.
-E, --excludeFilter {filter}
Filter to identify entries to exclude from the LDIF export.
-i, --includeAttribute {attribute}
Attribute to include in the LDIF export.
-I, --includeFilter {filter}
Filter to identify entries to include in the LDIF export.
-l, --ldifFile {ldifFile}
Path to the LDIF file to be written.
-n, --backendID {backendName}
Backend ID for the backend to export.
-O, --excludeOperational
Exclude operational attributes from the LDIF export.
--wrapColumn {wrapColumn}
Column at which to wrap long lines (0 for no wrapping). Default value: 0
--connectTimeout {timeout}
Maximum length of time (in milliseconds) that can be taken to establish a connection. Use \*(Aq0\*(Aq to specify no time out. Default value: 30000
-D, --bindDN {bindDN}
DN to use to bind to the server Default value: cn=Directory Manager
-h, --hostname {host}
Directory server hostname or IP address Default value: localhost.localdomain
-j, --bindPasswordFile {bindPasswordFile}
Bind password file
-K, --keyStorePath {keyStorePath}
Certificate key store path
-N, --certNickname {nickname}
Nickname of certificate for SSL client authentication
-o, --saslOption {name=value}
SASL bind options
-p, --port {port}
Directory server administration port number Default value: 4444
-P, --trustStorePath {trustStorePath}
Certificate trust store path
-T, --trustStorePassword {trustStorePassword}
Certificate trust store PIN
-u, --keyStorePasswordFile {keyStorePasswordFile}
Certificate key store PIN file
-U, --trustStorePasswordFile {path}
Certificate trust store PIN file
-w, --bindPassword {bindPassword}
Password to use to bind to the server Use -w - to have the command prompt for the password, rather than enter the password on the command line.
-W, --keyStorePassword {keyStorePassword}
Certificate key store PIN
-X, --trustAll
Trust all server SSL certificates
--completionNotify {emailAddress}
Email address of a recipient to be notified when the task completes. This option may be specified more than once.
--dependency {taskID}
ID of a task upon which this task depends. A task will not start execution until all its dependencies have completed execution.
--errorNotify {emailAddress}
Email address of a recipient to be notified if an error occurs when this task executes. This option may be specified more than once.
--failedDependencyAction {action}
Action this task will take should one if its dependent tasks fail. The value must be one of PROCESS, CANCEL, DISABLE. If not specified defaults to CANCEL.
--recurringTask {schedulePattern}
Indicates the task is recurring and will be scheduled according to the value argument expressed in crontab(5) compatible time/date pattern.
-t, --start {startTime}
Indicates the date/time at which this operation will start when scheduled as a server task expressed in YYYYMMDDhhmmssZ format for UTC time or YYYYMMDDhhmmss for local time. A value of \*(Aq0\*(Aq will cause the task to be scheduled for immediate execution. When this option is specified the operation will be scheduled to start at the specified time after which this utility will exit immediately.
--noPropertiesFile
No properties file will be used to get default command line argument values
--propertiesFilePath {propertiesFilePath}
Path to the file containing default property values used for command line arguments
-V, --version
Display version information
-?, -H, --help
Display usage information
0
The command completed successfully.
> 0
An error occurred.
The following example exports data to a file, Example.ldif, with the server offline.
.\}
$ export-ldif -b dc=example,dc=com -n userRoot -l ../ldif/Example.ldif [21/Jun/2011:13:40:49 +0200] category=BACKEND severity=INFORMATION ... ...Exported 160 entries and skipped 0 in 0 seconds (average rate 1428.6/sec)
Copyright \(co 2011-2012 ForgeRock AS