Data Sync Server Documentation Index
Command-Line Tool Reference Home

translate-ldif

Description
Examples
Arguments

Description

Translates the contents of an LDIF file from the format for a Sync Source to the format of the Sync Destination using the filtering and mapping criteria defined for Sync Classes in the specified Sync Pipe.

The translate-ldif command is typically used to convert an LDIF file exported from a Sync Source directory instance into the corresponding LDIF that can be imported into the Sync Destination directory. Entries and attributes that are not synchronized are filtered out. Attributes and DNs are mapped according to the mappings defined in the matching Sync Class.

Examples

Applies the filtering criteria and attribute mapping of 'Some Sync Pipe' to convert the source.ldif file, which is in the format of the Sync Source, into destination.ldif, which is in the format of the Sync Destination:
translate-ldif --pipe-name "Some Sync Pipe" --sourceLDIF source.ldif \
     --destinationLDIF destination.ldif

Arguments

-V
--version

Description Display Data Sync Server version information

-H
--help

Description Display general usage information

--help-debug

Description Display help for using debug options
Advanced Yes

-p Sync Pipe name
--pipe-name Sync Pipe name

Description Name of the Sync Pipe to use when translating the LDIF
Required Yes
Multi-Valued No

-l {path}
--sourceLDIF {path}

Description The path to the source LDIF file to be translated
Required Yes
Multi-Valued No

--sourceEncryptionPassphraseFile {file}

Description The path to a file that contains the encryption passphrase needed to decrypt the source LDIF file if it is encrypted. If the source file is encrypted and this argument is not provided, then the tool will interactively prompt for the encryption passphrase. If a passphrase file is provided, then it must contain exactly one line that consists entirely of the passphrase
Required No
Multi-Valued No

-o {path}
--destinationLDIF {path}

Description The path to use for the translated LDIF file to be written. Defaults to .translated
Required No
Multi-Valued No

--compressDestination

Description GZIP-Compress the data written to the destination file

--encryptDestination

Description Encrypt the data written to the destination file. if the --destinationEncryptionPassphraseFile argument is provided, then that passphrase will be used to encrypt the file; otherwise, the tool will interactively prompt for the passphrase

--destinationEncryptionPassphraseFile {file}

Description The path to a file that contains the encryption passphrase needed to encrypt the destination file if the --encryptDestination argument is provided. If the destination file is to be encrypted but no passphrase file is provided, then the tool will interactively prompt for the passphrase. If a passphrase file is given, then it must contain exactly one line that consists entirely of the passphrase
Required No
Multi-Valued No