Synchronization Server Documentation Index
Command-Line Tool Reference Home

parallel-update

Description
Examples
Arguments

Description

Perform add, delete, modify, and modify DN operations concurrently using multiple threads.

Examples

Apply the changes contained in the 'changes.ldif' file to the target server using ten concurrent threads working at 5000 updates per second (max) and write information about rejected changes to the 'rejected-changes.ldif' file:
parallel-update --hostname server.example.com --port 389 \
     --bindDN "cn=Directory Manager" --bindPassword password \
     --ldifFile changes.ldif --rejectFile rejected-changes.ldif --numThreads 10 \
     --ratePerSecond 5000

For examples and help with LDAP options see LDAP Option Help. For help with SASL authentication, see SASL Option Help

Arguments

-V
--version

Description Display Synchronization Server version information

-H
--help

Description Display general usage information

--help-ldap

Description Display help for using LDAP options

--help-sasl

Description Display help for using SASL options

--help-debug

Description Display help for using debug options
Advanced Yes

-h {host}
--hostname {host}

Description Synchronization Server hostname or IP address
Default Value localhost
Required No
Multi-Valued No

-p {port}
--port {port}

Description Synchronization Server port number
Lower Bound 1
Upper Bound 65535
Default Value 389
Required No
Multi-Valued No

-D {bindDN}
--bindDN {bindDN}

Description DN used to bind to the server
Required No
Multi-Valued No

-w {bindPassword}
--bindPassword {bindPassword}

Description Password used to bind to the server
Required No
Multi-Valued No

-j {bindPasswordFile}
--bindPasswordFile {bindPasswordFile}

Description Bind password file
Required No
Multi-Valued No

-Z
--useSSL

Description Use SSL for secure communication with the server

-q
--useStartTLS

Description Use StartTLS to secure communication with the server

-X
--trustAll

Description Trust all server SSL certificates

-K {keyStorePath}
--keyStorePath {keyStorePath}

Description Certificate key store path
Required No
Multi-Valued No

-W {keyStorePassword}
--keyStorePassword {keyStorePassword}

Description Certificate key store PIN
Required No
Multi-Valued No

-u {keyStorePasswordFile}
--keyStorePasswordFile {keyStorePasswordFile}

Description Certificate key store PIN file
Required No
Multi-Valued No

-P {trustStorePath}
--trustStorePath {trustStorePath}

Description Certificate trust store path
Required No
Multi-Valued No

-T {trustStorePassword}
--trustStorePassword {trustStorePassword}

Description Certificate trust store PIN
Required No
Multi-Valued No

-U {path}
--trustStorePasswordFile {path}

Description Certificate trust store PIN file
Required No
Multi-Valued No

-N {nickname}
--certNickname {nickname}

Description Nickname of the certificate for SSL client authentication
Required No
Multi-Valued No

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

Description SASL bind options
Required No
Multi-Valued Yes

--propertiesFilePath {propertiesFilePath}

Description Path to the file that contains default property values used for command-line arguments
Required No
Multi-Valued No

--noPropertiesFile

Description Specify that no properties file will be used to get default command-line argument values

--script-friendly

Description Use script-friendly mode

-l {ldifFile}
--ldifFile {ldifFile}

Description The path to the LDIF file to process
Required Yes
Multi-Valued No

-c
--isCompressed

Description LDIF file is compressed using gzip compression

-R {rejectFile}
--rejectFile {rejectFile}

Description The path to a file where rejected changes are written
Required Yes
Multi-Valued No

-L {logFile}
--logFile {logFile}

Description The path to the log file
Required No
Multi-Valued No

-t {numThreads}
--numThreads {numThreads}

Description The number of concurrent threads to use when applying changes
Lower Bound 1
Default Value 1
Required Yes
Multi-Valued No

-a
--defaultAdd

Description Treat any LDIF record without a changetype as an add record

-M
--usePermissiveModify

Description Include the permissive modify control in modify requests, which will prevent the server from rejecting a request attempting to add an attribute value that already exists or remove an attribute value that does not exist

--useSoftDelete

Description Process delete operations as soft delete requests, whereby entries are renamed and hidden instead of being permanently deleted. The Directory Server must be configured to allow soft deletes

--allowUndelete

Description Process add operations which include the ds-undelete-from-dn attribute as undelete requests. Undelete requests re-add previously soft-deleted entries back to the directory as non-deleted entries by providing the Undelete Request Control with the add operation. The Directory Server must be configured to allow soft deletes to process any undelete requests and the client user must have the soft-delete-read privilege

-r
--neverRetry

Description Always reject failed operations even if they might succeed after retrying them

-s {ratePerSecond}
--ratePerSecond {ratePerSecond}

Description Maximum rate in operations per second the tool should execute
Required No
Multi-Valued No