import-ldif
Prev | Directory Server Tools | Next

## Name

import-ldif — import OpenDJ directory data from LDIF

## Synopsis

`import-ldif`

## Description

This utility can be used to import LDIF data into a Directory Server backend, overwriting existing data. It cannot be used to append data to the backend database.

## Options

The import-ldif command takes the following options:

Command options:

`-A | --templateFile {templateFile}`

  Path to a MakeLDIF template to use to generate the import data.

`-b | --includeBranch {branchDN}`

  Base DN of a branch to include in the LDIF import.

`-B | --excludeBranch {branchDN}`

  Base DN of a branch to exclude from the LDIF import.

`-c | --isCompressed`

  LDIF file is compressed.

  Default: false

`--countRejects`

  Count the number of entries rejected by the server and return that value as the exit code (values > 255 will be reduced to 255 due to exit code restrictions).

  Default: false

`-e | --excludeAttribute {attribute}`

  Attribute to exclude from the LDIF import.

`-E | --excludeFilter {filter}`

  Filter to identify entries to exclude from the LDIF import.

`-F | --clearBackend`

  Remove all entries for all base DNs in the backend before importing.

  Default: false

`-i | --includeAttribute {attribute}`

  Attribute to include in the LDIF import.

`-I | --includeFilter {filter}`

  Filter to identify entries to include in the LDIF import.

`-l | --ldifFile {ldifFile}`

  Path to the LDIF file to be imported.

`-n | --backendID {backendName}`

  Backend ID for the backend to import.

`-O | --overwrite`

  Overwrite an existing rejects and/or skip file rather than appending to it.

  Default: false

`--offline`

  Indicates that the command must be run in offline mode.

  Default: false

`-R | --rejectFile {rejectFile}`

  Write rejected entries to the specified file.

`-s | --randomSeed {seed}`

  Seed for the MakeLDIF random number generator.

  Default: 0

`-S | --skipSchemaValidation`

  Skip schema validation during the LDIF import.

  Default: false

`--skipFile {skipFile}`

  Write skipped entries to the specified file.

`--threadCount {count}`

  Number of threads used to read LDIF file during import. Default value (0) equals: 2 x (number of CPUs).

  Default: 0

`--tmpdirectory {directory}`

  Path to temporary directory for index scratch files during LDIF import.

  Default: import-tmp

Task Backend Connection Options

`--connectTimeout {timeout}`

  Maximum length of time (in milliseconds) that can be taken to establish a connection. Use '0' to specify no time out.

  Default: 30000

`-D | --bindDN {bindDN}`

  DN to use to bind to the server.

  Default: cn=Directory Manager

`-h | --hostname {host}`

  The fully-qualified directory server host name that will be used when generating self-signed certificates for LDAP SSL/StartTLS, the administration connector, and replication.

  Default: localhost.localdomain

`-j | --bindPasswordFile {bindPasswordFile}`

  Bind password file.

`-K | --keyStorePath {keyStorePath}`

  Certificate key store path.

`-N | --certNickname {nickname}`

  Nickname of the certificate that the server should use when accepting SSL-based connections or performing StartTLS negotiation.

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

  SASL bind options.

`-p | --port {port}`

  Directory server administration port number.

  Default: 4444

`-P | --trustStorePath {trustStorePath}`

  Certificate trust store path.

`-T | --trustStorePassword {trustStorePassword}`

  Certificate trust store PIN.

`-u | --keyStorePasswordFile {keyStorePasswordFile}`

  Certificate key store PIN file. A PIN is required when you specify to use an existing certificate as server certificate.

`-U | --trustStorePasswordFile {path}`

  Certificate trust store PIN file.

`-w | --bindPassword {bindPassword}`

  Password to use to bind to the server. Use -w - to ensure that the command prompts for the password, rather than entering the password as a command argument.

`-W | --keyStorePassword {keyStorePassword}`

  Certificate key store PIN. A PIN is required when you specify to use an existing certificate as server certificate.

`-X | --trustAll`

  Trust all server SSL certificates.

  Default: false

Task Scheduling Options

`--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 '0' 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.

Utility input/output options:

`--noPropertiesFile`

  No properties file will be used to get default command line argument values.

  Default: false

`--propertiesFilePath {propertiesFilePath}`

  Path to the file containing default property values used for command line arguments.

`-Q | --quiet`

  Use quiet mode (no output).

  Default: false

General options:

`-V | --version`

  Display Directory Server version information.

  Default: false

`-H | --help`

  Display this usage information.

  Default: false

## Exit Codes

0

  The command completed successfully.

> 0

  An error occurred.

## Examples

The following example imports the content of a file, `Example.ldif`, with the server offline.

    $ import-ldif -b dc=example,dc=com -n userRoot -l /path/to/Example.ldif
    ... category=RUNTIME_INFORMATION severity=NOTICE...
    ... msg=Import LDIF environment close took 0 seconds

Prev | Up | Next
export-ldif | Home | ldapcompare