1 .TH LDAPCOMPARE 1 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2004 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldapcompare \- LDAP compare tool
22 .BI \-d \ debuglevel\fR]
30 .BI \-y \ passwdfile\fR]
34 .BI \-h \ ldaphost\fR]
36 .BI \-p \ ldapport\fR]
38 .BI \-P \ 2\fR\||\|\fI3\fR]
40 .BR \-O \ security-properties ]
59 .BR attr::b64value \ >
62 is a shell-accessible interface to the
67 opens a connection to an LDAP server, binds, and performs a compare
68 using specified parameters. The \fIDN\fP should be a distinguished
69 name in the directory. \fIAttr\fP should be a known attribute. If
70 followed by one colon, the assertion \fIvalue\fP should be provided
71 as a string. If followed by two colons, the base64 encoding of the
72 value is provided. The result code of the compare is provided as
73 the exit code and, unless ran with -z, the program prints
74 TRUE, FALSE, or UNDEFINED on standard output.
79 Show what would be done, but don't actually perform the compare. Useful for
80 debugging in conjunction with -v.
83 Run in verbose mode, with many diagnostics written to standard output.
86 Run in quiet mode, no output is written. You must check the return
87 status. Useful in shell scripts.
90 Use Kerberos IV authentication instead of simple authentication. It is
91 assumed that you already have a valid ticket granting ticket.
93 must be compiled with Kerberos support for this option to have any effect.
96 Same as \-k, but only does step 1 of the Kerberos IV bind. This is useful
97 when connecting to a slapd and there is no x500dsa.hostname principal
98 registered with your Kerberos Domain Controller(s).
101 Enable manage DSA IT control.
103 makes control critical.
106 Set the LDAP debugging level to \fIdebuglevel\fP.
108 must be compiled with LDAP_DEBUG defined for this option to have any effect.
111 Use simple authentication instead of SASL.
114 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
117 Prompt for simple authentication.
118 This is used instead of specifying the password on the command line.
121 Use \fIpasswd\fP as the password for simple authentication.
124 Use complete contents of \fIpasswdfile\fP as the password for
125 simple authentication.
128 Specify URI(s) referring to the ldap server(s).
131 Specify an alternate host on which the ldap server is running.
132 Deprecated in favor of -H.
135 Specify an alternate TCP port where the ldap server is listening.
136 Deprecated in favor of -H.
138 .BI \-P \ 2\fR\||\|\fI3
139 Specify the LDAP protocol version to use.
141 .BI \-O \ security-properties
142 Specify SASL security properties.
145 Enable SASL Interactive mode. Always prompt. Default is to prompt
149 Enable SASL Quiet mode. Never prompt.
152 Specify the authentication ID for SASL bind. The form of the ID
153 depends on the actual SASL mechanism used.
156 Specify the realm of authentication ID for SASL bind. The form of the realm
157 depends on the actual SASL mechanism used.
160 Specify the requested authorization ID for SASL bind.
162 must be one of the following formats:
164 .I <distinguished name>
170 Specify the SASL mechanism to be used for authentication. If it's not
171 specified, the program will choose the best mechanism the server knows.
174 Issue StartTLS (Transport Layer Security) extended operation. If you use
176 , the command will require the operation to be successful.
179 ldapcompare "uid=babs,dc=example,dc=com" sn:Jensen
180 ldapcompare "uid=babs,dc=example,dc=com" sn::SmVuc2Vu
184 Requiring the value be passed on the command line is limiting
185 and introduces some security concerns. The command should support
186 a mechanism to specify the location (file name or URL) to read
194 The OpenLDAP Project <http://www.openldap.org/>
197 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
199 is derived from University of Michigan LDAP 3.3 Release.