ldapexop — issue LDAP extended operations
whoami ldapexop [
−V [V] ] [ −d debuglevel ] [−n] [−v] [ −f file ] [−x] [ −D binddn ] [−W] [ −w passwd ] [ −y passwdfile ] [ −H URI ] [ −h ldaphost ] [ −p ldapport ] [ −e [!] ext [=extparam] ] [
−o opt [ = optparam ] ] [
−O
security−properties ] [−I] [−Q] [−N] [ −U authcid ] [ −R realm ] [ −X authzid ] [ −Y mech ] [ −Z [Z] ] oid | oid: data | oid::
b64data | cancel cancel−id | refresh DN [ttl]
ldapexop issues the LDAP extended operation specified by
oid or one of the
special keywords whoami, cancel, or refresh.
Additional data for the extended operation can be passed
to the server using data or base-64 encoded as
b64data in the case
of oid, or using the
additional parameters in the case of the specially named
extended operations above.
Please note that ldapexop behaves differently for the same extended operation when it was given as an OID or as a specialliy named operation:
Calling ldapexop with the OID of the whoami (RFC 4532) extended
operation
ldapexop [<options>] 1.3.6.1.4.1.4203.1.11.3
yields
# extended operation response data:: <base64 encoded response data>
while calling it with the keyword whoami
ldapexop [<options>] whoami
results in
dn:<client's identity>
−V[V]Print version info. If−VV is given, only the version
information is printed.
−d
debuglevelSet the LDAP debugging level to debuglevel.
−nShow what would be done but don't actually do it.
Useful for debugging in conjunction with −v.
−vRun in verbose mode, with many diagnostics written to standard output.
−f
fileRead operations from file.
−xUse simple authentication instead of SASL.
−D
binddnUse the Distinguished Name binddn to bind to the
LDAP directory.
−WPrompt for simple authentication. This is used instead of specifying the password on the command line.
−w
passwdUse passwd
as the password for simple authentication.
−y
passwdfileUse complete contents of passwdfile as the
password for simple authentication.
−H
URISpecify URI(s) referring to the ldap server(s); only the protocol/host/port fields are allowed; a list of URI, separated by whitespace or commas is expected.
−h
ldaphostSpecify the host on which the ldap server is
running. Deprecated in favor of −H.
−p
ldapportSpecify the TCP port where the ldap server is
listening. Deprecated in favor of −H.
−e
[!]ext[=extparam]Specify general extensions. '!' indicates criticality.
[!]assert=<filter> (an RFC 4515 Filter)
!authzid=<authzid> ("dn:<dn>" or "u:<user>")
[!]bauthzid (RFC 3829 authzid control)
[!]chaining[=<resolve>[/<cont>]]
[!]manageDSAit
[!]noop
ppolicy
[!]postread[=<attrs>] (a comma-separated attribute list)
[!]preread[=<attrs>] (a comma-separated attribute list)
[!]relax
sessiontracking
abandon,cancel,ignore (SIGINT sends abandon/cancel,
or ignores response; if critical, doesn't wait for SIGINT.
not really controls)
−o
opt[=optparam]Specify general options.
General options:
nettimeout=<timeout> (in seconds, or "none" or "max") ldif-wrap=<width> (in columns, or "no" for no wrapping)
−O
security−propertiesSpecify SASL security properties.
−IEnable SASL Interactive mode. Always prompt. Default is to prompt only as needed.
−QEnable SASL Quiet mode. Never prompt.
−NDo not use reverse DNS to canonicalize SASL host name.
−U
authcidSpecify the authentication ID for SASL bind. The form of the ID depends on the actual SASL mechanism used.
−R
realmSpecify the realm of authentication ID for SASL bind. The form of the realm depends on the actual SASL mechanism used.
−X
authzidSpecify the requested authorization ID for SASL
bind. authzid
must be one of the following formats: dn:<distinguished name>
or u:<username>
−Y
mechSpecify the SASL mechanism to be used for authentication. Without this option, the program will choose the best mechanism the server knows.
−Z[Z]Issue StartTLS (Transport Layer Security) extended
operation. Giving it twice (−ZZ) will require the operation
to be successful.
Exit status is zero if no errors occur. Errors result in a non-zero exit status and a diagnostic message being written to standard error.
This manual page was written by Peter Marschall based on
ldapexop's usage
message and a few tests with ldapexop. Do not expect it to
be complete or absolutely correct.
OpenLDAP Software is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>. OpenLDAP Software is derived from University of Michigan LDAP 3.3 Release.