The move-subtree Command-Line Tool

Move all entries in a specified subtree from one server to another.

Usage

move-subtree {arguments}

Source Connection and Authentication Arguments

--sourceHostname {host} — The IP address or resolvable name to use to connect to the directory server. If this is not provided, then a default value of 'localhost' will be used.
--sourcePort {port} — The port to use to connect to the directory server. If this is not provided, then a default value of 389 will be used.
The specified value must not be less than 1 or greater than 65,535.
--sourceBindDN {dn} — The DN to use to bind to the directory server when performing simple authentication.
A provided value must be able to be parsed as an LDAP distinguished name as described in RFC 4514.
--sourceBindPassword {password} — The password to use to bind to the directory server when performing simple authentication or a password-based SASL mechanism.
--sourceBindPasswordFile {path} — The path to the file containing the password to use to bind to the directory server when performing simple authentication or a password-based SASL mechanism.
The specified path must refer to a file that exists.
--sourceUseSSL — Use SSL when communicating with the directory server.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
--sourceUseStartTLS — Use StartTLS when communicating with the directory server.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
--sourceDefaultTrust — Use the JVM's default trust store, and optionally an additional trust store specified using the --trustStorePath argument, to non-interactively determine whether to trust any certificate chain presented during TLS negotiation. If the chain cannot be trusted based on any of those sources, then negotiation will fail without prompting about whether to trust it.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
--sourceTrustAll — Trust any certificate presented by the directory server.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
--sourceKeyStorePath {path} — The path to the file to use as the key store for obtaining client certificates when communicating securely with the directory server.
--sourceKeyStorePassword {password} — The password to use to access the key store contents.
--sourceKeyStorePasswordFile {path} — The path to the file containing the password to use to access the key store contents.
The specified path must refer to a file that exists.
--sourceKeyStoreFormat {format} — The format (e.g., JKS, PKCS12, PKCS11, BCFKS, etc.) for the key store file.
--sourceTrustStorePath {path} — The path to the file to use as trust store when determining whether to trust a certificate presented by the directory server.
--sourceTrustStorePassword {password} — The password to use to access the trust store contents.
--sourceTrustStorePasswordFile {path} — The path to the file containing the password to use to access the trust store contents.
The specified path must refer to a file that exists.
--sourceTrustStoreFormat {format} — The format (e.g., JKS, PKCS12, PKCS11, BCFKS, etc.) for the trust store file.
--sourceCertNickname {nickname} — The nickname (alias) of the client certificate in the key store to present to the directory server for SSL client authentication.
--sourceSASLOption {name=value} — A name-value pair providing information to use when performing SASL authentication.

Target Connection and Authentication Arguments

--targetHostname {host} — The IP address or resolvable name to use to connect to the directory server. If this is not provided, then a default value of 'localhost' will be used.
--targetPort {port} — The port to use to connect to the directory server. If this is not provided, then a default value of 389 will be used.
The specified value must not be less than 1 or greater than 65,535.
--targetBindDN {dn} — The DN to use to bind to the directory server when performing simple authentication.
A provided value must be able to be parsed as an LDAP distinguished name as described in RFC 4514.
--targetBindPassword {password} — The password to use to bind to the directory server when performing simple authentication or a password-based SASL mechanism.
--targetBindPasswordFile {path} — The path to the file containing the password to use to bind to the directory server when performing simple authentication or a password-based SASL mechanism.
The specified path must refer to a file that exists.
--targetUseSSL — Use SSL when communicating with the directory server.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
--targetUseStartTLS — Use StartTLS when communicating with the directory server.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
--targetDefaultTrust — Use the JVM's default trust store, and optionally an additional trust store specified using the --trustStorePath argument, to non-interactively determine whether to trust any certificate chain presented during TLS negotiation. If the chain cannot be trusted based on any of those sources, then negotiation will fail without prompting about whether to trust it.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
--targetTrustAll — Trust any certificate presented by the directory server.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
--targetKeyStorePath {path} — The path to the file to use as the key store for obtaining client certificates when communicating securely with the directory server.
--targetKeyStorePassword {password} — The password to use to access the key store contents.
--targetKeyStorePasswordFile {path} — The path to the file containing the password to use to access the key store contents.
The specified path must refer to a file that exists.
--targetKeyStoreFormat {format} — The format (e.g., JKS, PKCS12, PKCS11, BCFKS, etc.) for the key store file.
--targetTrustStorePath {path} — The path to the file to use as trust store when determining whether to trust a certificate presented by the directory server.
--targetTrustStorePassword {password} — The password to use to access the trust store contents.
--targetTrustStorePasswordFile {path} — The path to the file containing the password to use to access the trust store contents.
The specified path must refer to a file that exists.
--targetTrustStoreFormat {format} — The format (e.g., JKS, PKCS12, PKCS11, BCFKS, etc.) for the trust store file.
--targetCertNickname {nickname} — The nickname (alias) of the client certificate in the key store to present to the directory server for SSL client authentication.
--targetSASLOption {name=value} — A name-value pair providing information to use when performing SASL authentication.

Additional Arguments

-b {dn} / --baseDN {dn} — The base DN of the subtree to move.
A provided value must be able to be parsed as an LDAP distinguished name as described in RFC 4514.
-f {path} / --baseDNFile {path} — The path to a file containing the base DNs of the subtrees to move. Each subtree base DN should be provided on a separate line.
The specified path must refer to a file that exists.
-z {num} / --sizeLimit {num} — The maximum number of entries to allow for the move.
The specified value must not be less than 0 or greater than 2,147,483,647.
--purpose {purpose} — The reason that the subtree is to be moved from the source server to the target server.
-v / --verbose — Indicates that the tool should operate in verbose mode in which it will output detailed information as entries are added to the target server and removed from the source server.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
--outputFile {path} — Write all standard output and standard error messages to the specified file instead of to the console.
The specified path must refer to a file which may or may not exist, but whose parent directory must exist.
--appendToOutputFile — Indicates that the tool should append to the file specified by the --outputFile argument if it already exists. If this argument is not provided and the output file already exists, it will be overwritten.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
--teeOutput — Write all standard output and standard error messages to the console as well as to the specified output file. The --outputFile argument must also be provided.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
-H / --help — Display usage information for this program.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
--help-debug — Display usage information for debug logging.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
--enable-debug-logging — Enables debug logging for the tool.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
--debug-log-level {level} — The debug log level to use for the tool. Allowed values include 'off', 'severe', 'warning', 'info', 'fine', 'finer', and 'finest'. If this is not specified, a default level of 'severe' will be used.
--debug-log-category {category} — The message categories to include in the debug log output. Allowed values include 'asn1', 'connect', 'exception', 'ldap', 'connectionpool', 'ldif', 'monitor', 'codingerror', and 'other'. This argument may be provided multiple times to indicate that multiple categories should be included. If this is not specified, then all categories will be included.
--include-debug-stack-traces — Indicates that debug log messages should include a stack trace with the code location from which each debug message originated.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
--use-multi-line-debug-messages — Indicates that debug log messages (which will be JSON objects) should be written as multi-line strings rather than single-line strings.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
--debug-log-file {path} — The path to the debug log file to be written. If this is not specified, a default path of 'move-subtree.debug' will be used.
The specified path must refer to a file which may or may not exist, but whose parent directory must exist.
-V / --version — Display version information for this program.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
--propertiesFilePath {path} — The path to a properties file used to specify default values for arguments not supplied on the command line.
The specified path must refer to a file that exists.
--generatePropertiesFile {path} — Write an empty properties file that may be used to specify default values for arguments.
The specified path must refer to a file which may or may not exist, but whose parent directory must exist.
--noPropertiesFile — Do not obtain any argument values from a properties file.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.
--suppressPropertiesFileComment — Suppress output listing the arguments obtained from a properties file.
This argument is not allowed to have a value. If this argument is included in a set of arguments, then it will be assumed to have a value of 'true'. If it is absent from a set of arguments, then it will be assumed to have a value of 'false'.

Required Argument Sets

At least one of the following arguments must be provided: --baseDN, --baseDNFile

Dependent Argument Sets

If the --sourceBindDN argument is provided, then at least one of the following arguments must also be provided: --sourceBindPassword, --sourceBindPasswordFile
If the --targetBindDN argument is provided, then at least one of the following arguments must also be provided: --targetBindPassword, --targetBindPasswordFile
If the --appendToOutputFile argument is provided, then the --outputFile argument must also be provided.
If the --teeOutput argument is provided, then the --outputFile argument must also be provided.

Exclusive Argument Sets

The following arguments cannot be used together: --sourceUseSSL, --sourceUseStartTLS
The following arguments cannot be used together: --sourceBindPassword, --sourceBindPasswordFile
The following arguments cannot be used together: --sourceKeyStorePassword, --sourceKeyStorePasswordFile
The following arguments cannot be used together: --sourceTrustStorePassword, --sourceTrustStorePasswordFile
The following arguments cannot be used together: --sourceTrustAll, --sourceTrustStorePath
The following arguments cannot be used together: --sourceTrustAll, --sourceDefaultTrust
The following arguments cannot be used together: --targetUseSSL, --targetUseStartTLS
The following arguments cannot be used together: --targetBindPassword, --targetBindPasswordFile
The following arguments cannot be used together: --targetKeyStorePassword, --targetKeyStorePasswordFile
The following arguments cannot be used together: --targetTrustStorePassword, --targetTrustStorePasswordFile
The following arguments cannot be used together: --targetTrustAll, --targetTrustStorePath
The following arguments cannot be used together: --targetTrustAll, --targetDefaultTrust
The following arguments cannot be used together: --baseDN, --baseDNFile
The following arguments cannot be used together: --propertiesFilePath, --noPropertiesFile

Examples

Migrate all entries at or below 'cn=small subtree,dc=example,dc=com' from source server 'ds1.example.com' to target server 'ds2.example.com'.

    move-subtree --sourceHostname ds1.example.com --sourcePort 389 \
         --sourceBindDN uid=admin,dc=example,dc=com \
         --sourceBindPassword password --targetHostname ds2.example.com \
         --targetPort 389 --targetBindDN uid=admin,dc=example,dc=com \
         --targetBindPassword password \
         --baseDN "cn=small subtree,dc=example,dc=com" --sizeLimit 100 \
         --purpose "Migrate a small subtree from ds1 to ds2"