1LDAPEXOP(1) General Commands Manual LDAPEXOP(1)
3
7 ldapexop - issue LDAP extended operations
8
11 ldapexop [-V[V]] [-d debuglevel] [-n] [-v] [-f file] [-x] [-D binddn]
12 [-W] [-w passwd] [-y passwdfile] [-H URI] [-h ldaphost] [-p ldapport]
13 [-e [!]ext[=extparam]] [-o opt[=optparam]] [-O security-properties]
14 [-I] [-Q] [-N] [-U authcid] [-R realm] [-X authzid] [-Y mech] [-Z[Z]]
15 {oid | oid:data | oid::b64data | whoami | cancel cancel-id | re‐
16 fresh DN [ttl]}
17
20 ldapexop issues the LDAP extended operation specified by oid or one of
21 the special keywords whoami, cancel, or refresh.
22 Additional data for the extended operation can be passed to the server
24 using data or base-64 encoded as b64data in the case of oid, or using
25 the additional parameters in the case of the specially named extended
26 operations above.
27 Please note that ldapexop behaves differently for the same extended op‐
29 eration when it was given as an OID or as a specialliy named operation:
30 Calling ldapexop with the OID of the whoami (RFC 4532) extended opera‐
32 tion
33 ldapexop [<options>] 1.3.6.1.4.1.4203.1.11.3
35 yields
37 # extended operation response
39 data:: <base64 encoded response data>
40 while calling it with the keyword whoami
42 ldapexop [<options>] whoami
44 results in
46 dn:<client's identity>
48
53 -V[V] Print version info. If-VV is given, only the version informa‐
54 tion is printed.
55 -d debuglevel
57 Set the LDAP debugging level to debuglevel.
58 -n Show what would be done but don't actually do it. Useful for
60 debugging in conjunction with -v.
61 -v Run in verbose mode, with many diagnostics written to standard
63 output.
64 -f file
66 Read operations from file.
67 -x Use simple authentication instead of SASL.
69 -D binddn
71 Use the Distinguished Name binddn to bind to the LDAP directory.
72 -W Prompt for simple authentication. This is used instead of spec‐
74 ifying the password on the command line.
75 -w passwd
77 Use passwd as the password for simple authentication.
78 -y passwdfile
80 Use complete contents of passwdfile as the password for simple
81 authentication.
82 -H URI Specify URI(s) referring to the ldap server(s); only the proto‐
84 col/host/port fields are allowed; a list of URI, separated by
85 whitespace or commas is expected.
86 -h ldaphost
88 Specify the host on which the ldap server is running. Depre‐
89 cated in favor of -H.
90 -p ldapport
92 Specify the TCP port where the ldap server is listening. Depre‐
93 cated in favor of -H.
94 -e [!]ext[=extparam]
96 Specify general extensions. ´!´ indicates criticality.
97 [!]assert=<filter> (an RFC 4515 Filter)
98 !authzid=<authzid> ("dn:<dn>" or "u:<user>")
99 [!]bauthzid (RFC 3829 authzid control)
100 [!]chaining[=<resolve>[/<cont>]]
101 [!]manageDSAit
102 [!]noop
103 ppolicy
104 [!]postread[=<attrs>] (a comma-separated attribute list)
105 [!]preread[=<attrs>] (a comma-separated attribute list)
106 [!]relax
107 sessiontracking
108 abandon,cancel,ignore (SIGINT sends abandon/cancel,
109 or ignores response; if critical, doesn't wait for SIGINT.
110 not really controls)
111 -o opt[=optparam]
113 Specify any ldap.conf(5) option or one of the following:
115 nettimeout=<timeout> (in seconds, or "none" or "max")
116 ldif_wrap=<width> (in columns, or "no" for no wrapping)
117 -O security-properties
120 Specify SASL security properties.
121 -I Enable SASL Interactive mode. Always prompt. Default is to
123 prompt only as needed.
124 -Q Enable SASL Quiet mode. Never prompt.
126 -N Do not use reverse DNS to canonicalize SASL host name.
128 -U authcid
130 Specify the authentication ID for SASL bind. The form of the ID
131 depends on the actual SASL mechanism used.
132 -R realm
134 Specify the realm of authentication ID for SASL bind. The form
135 of the realm depends on the actual SASL mechanism used.
136 -X authzid
138 Specify the requested authorization ID for SASL bind. authzid
139 must be one of the following formats: dn:<distinguished name> or
140 u:<username>
141 -Y mech
143 Specify the SASL mechanism to be used for authentication. With‐
144 out this option, the program will choose the best mechanism the
145 server knows.
146 -Z[Z] Issue StartTLS (Transport Layer Security) extended operation.
148 Giving it twice (-ZZ) will require the operation to be success‐
149 ful.
150
153 Exit status is zero if no errors occur. Errors result in a non-zero
154 exit status and a diagnostic message being written to standard error.
155
158 ldap_extended_operation_s(3)
159
162 This manual page was written by Peter Marschall based on ldapexop's us‐
163 age message and a few tests with ldapexop. Do not expect it to be com‐
164 plete or absolutely correct.
165
168 OpenLDAP Software is developed and maintained by The OpenLDAP Project
169 <http://www.openldap.org/>. OpenLDAP Software is derived from the Uni‐
170 versity of Michigan LDAP 3.3 Release.
171 LDAPEXOP(1)