<?xml version="1.0" encoding="UTF-8"?>

<refentry xml:id='ldapcompare-1'

xmlns='http://docbook.org/ns/docbook'

version='5.0' xml:lang='en'

xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'

xsi:schemaLocation='http://docbook.org/ns/docbook

xmlns:xlink='http://www.w3.org/1999/xlink'>

<info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>

<refmeta>

<refentrytitle>ldapcompare</refentrytitle><manvolnum>1</manvolnum>

<refmiscinfo class="software">OpenDJ</refmiscinfo>

<refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>

</refmeta>

<refnamediv>

<refname>ldapcompare</refname>

<refpurpose>perform LDAP compare operations</refpurpose>

</refnamediv>

<refsynopsisdiv>

<cmdsynopsis>

<command>ldapcompare</command>

<arg choice="req">options</arg>

<group><arg>attribute</arg><arg>:</arg><arg>value</arg></group>

<arg choice="opt" rep="repeat">DN</arg>

</cmdsynopsis>

</refsynopsisdiv>

<refsect1>

<title>Description</title>

<para>This utility can be used to perform LDAP compare operations in the

directory.</para>

</refsect1>

<refsect1>

<title>Options</title>

<para>The following options are supported.</para>

<variablelist>

<varlistentry>

<term><option>--assertionFilter {filter}</option></term>

<listitem>

<para>Use the LDAP assertion control with the provided filter</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-c, --continueOnError</option></term>

<listitem>

<para>Continue processing even if there are errors</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-f, --filename {file}</option></term>

<listitem>

<para>LDIF file containing one DN per line of entries to compare</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-J, --control {controloid[:criticality[:value|::b64value|:&lt;filePath]]}</option></term>

<listitem>

<para>Use a request control with the provided information</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-m, --useCompareResultCode</option></term>

<listitem>

<para>Use the LDAP compare result as an exit code for the LDAP compare operations.</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-n, --dry-run</option></term>

<listitem>

<para>Show what would be done but do not perform any operation</para>

</listitem>

</varlistentry>

</variablelist>

<refsect2>

<title>LDAP Connection Options</title>

<variablelist>

<varlistentry>

<term><option>--connectTimeout {timeout}</option></term>

<listitem>

<para>Maximum length of time (in milliseconds) that can be taken to

establish a connection. Use '0' to specify no time out.</para>

<para>Default value: 30000</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-D, --bindDN {bindDN}</option></term>

<listitem>

<para>DN to use to bind to the server</para>

<para>Default value: cn=Directory Manager</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-h, --hostname {host}</option></term>

<listitem>

<para>Directory server hostname or IP address</para>

<para>Default value: localhost.localdomain</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>

<listitem>

<para>Bind password file</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-K, --keyStorePath {keyStorePath}</option></term>

<listitem>

<para> Certificate key store path</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-N, --certNickname {nickname}</option></term>

<listitem>

<para>Nickname of certificate for SSL client authentication</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-o, --saslOption {name=value}</option></term>

<listitem>

<para>SASL bind options</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-p, --port {port}</option></term>

<listitem>

<para>Directory server port number</para>

<para>Default value: 389</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-P, --trustStorePath {trustStorePath}</option></term>

<listitem>

<para>Certificate trust store path</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-q, --useStartTLS</option></term>

<listitem>

<para>Use StartTLS to secure communication with the server</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-r, --useSASLExternal</option></term>

<listitem>

<para>Use the SASL EXTERNAL authentication mechanism</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>--trustStorePassword {trustStorePassword}</option></term>

<listitem>

<para>Certificate trust store PIN</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>

<listitem>

<para>Certificate key store PIN file</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-U, --trustStorePasswordFile {path}</option></term>

<listitem>

<para>Certificate trust store PIN file</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-V, --ldapVersion {version}</option></term>

<listitem>

<para>LDAP protocol version number</para>

<para>Default value: 3</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-w, --bindPassword {bindPassword}</option></term>

<listitem>

<para>Password to use to bind to the server</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-W, --keyStorePassword {keyStorePassword}</option></term>

<listitem>

<para>Certificate key store PIN</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-X, --trustAll</option></term>

<listitem>

<para>Trust all server SSL certificates</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-Z, --useSSL</option></term>

<listitem>

<para>Use SSL for secure communication with the server</para>

</listitem>

</varlistentry>

</variablelist>

</refsect2>

<refsect2>

<title>Utility Input/Output Options</title>

<variablelist>

<varlistentry>

<term><option>-i, --encoding {encoding}</option></term>

<listitem>

<para>Use the specified character set for command-line input</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>--noPropertiesFile</option></term>

<listitem>

<para>No properties file will be used to get default command line

argument values</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>--propertiesFilePath {propertiesFilePath}</option></term>

<listitem>

<para>Path to the file containing default property values used for

command line arguments</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-s, --script-friendly</option></term>

<listitem>

<para>Use script-friendly mode</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-v, --verbose</option></term>

<listitem>

<para>Use verbose mode</para>

</listitem>

</varlistentry>

</variablelist>

</refsect2>

<refsect2>

<title>General Options</title>

<variablelist>

<varlistentry>

<term><option>--version</option></term>

<listitem>

<para>Display version information</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-?, -H, --help</option></term>

<listitem>

<para>Display usage information</para>

</listitem>

</varlistentry>

</variablelist>

</refsect2>

</refsect1>

<refsect1>

<title>Exit Codes</title>

<variablelist>

<varlistentry>

<term>0</term>

<listitem>

<para>The command completed successfully.</para>

</listitem>

</varlistentry>

<varlistentry>

<term>5</term>

<listitem>

<para>The -m option was used, and at least one of the LDAP compare operations did not match.</para>

</listitem>

</varlistentry>

<varlistentry>

<term>6</term>

<listitem>

<para>The -m option was used, and all the LDAP compare operations did match.</para>

</listitem>

</varlistentry>

<varlistentry>

<term><replaceable>ldap-error</replaceable></term>

<listitem>

<para>An LDAP error occurred while processing the operation.</para>

<para>LDAP result codes are described in <link

xlink:href="http://tools.ietf.org/html/rfc4511#appendix-A">RFC

4511</link>. Also see the additional information for details.</para>

</listitem>

</varlistentry>

<varlistentry>

<term>89</term>

<listitem>

<para>An error occurred while parsing the command-line arguments.</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1>

<title>Files</title>

<para>You can use <filename>~/.opendj/tools.properties</filename> to set

the defaults for bind DN, host name, and port number as in the following

example.</para>

<programlisting language="ini">

hostname=directory.example.com

port=1389

bindDN=uid=kvaughan,ou=People,dc=example,dc=com

ldapcompare.port=1389

ldapdelete.port=1389

ldapmodify.port=1389

ldappasswordmodify.port=1389

ldapsearch.port=1389

</programlisting>

</refsect1>

<refsect1>

<title>Examples</title>

<para>The following examples demonstrate comparing Babs Jensen's UID.</para>

<para>The following example uses a matching UID value.</para>

<screen>

$ <userinput>ldapcompare -p 1389 uid:bjensen uid=bjensen,ou=people,dc=example,dc=com</userinput>

<computeroutput>Comparing type uid with value bjensen in entry

uid=bjensen,ou=people,dc=example,dc=com

Compare operation returned true for entry

uid=bjensen,ou=people,dc=example,dc=com</computeroutput>

</screen>

<para>The following example uses a UID value that does not match.</para>

<screen>

$ <userinput>ldapcompare -p 1389 uid:beavis uid=bjensen,ou=people,dc=example,dc=com</userinput>

<computeroutput>Comparing type uid with value beavis in entry

uid=bjensen,ou=people,dc=example,dc=com

Compare operation returned false for entry

uid=bjensen,ou=people,dc=example,dc=com</computeroutput>

</screen>

</refsect1>

</refentry>