ldapmodify (1) - Linux Manuals
ldapmodify: LDAP modify entry and LDAP add entry tools
ldapmodify, ldapadd - LDAP modify entry and LDAP add entry tools
SYNOPSISldapmodify [-V[V]] [-d
DESCRIPTIONldapmodify is a shell-accessible interface to the ldap_add_ext(3), ldap_modify_ext(3), ldap_delete_ext(3) and ldap_rename(3). library calls. ldapadd is implemented as a hard link to the ldapmodify tool. When invoked as ldapadd the -a (add new entry) flag is turned on automatically.
ldapmodify opens a connection to an LDAP server, binds, and modifies or adds entries. The entry information is read from standard input or from file through the use of the -f option.
- Print version info. If -VV is given, only the version information is printed.
- Set the LDAP debugging level to debuglevel. ldapmodify must be compiled with LDAP_DEBUG defined for this option to have any effect.
- Show what would be done, but don't actually modify entries. Useful for debugging in conjunction with -v.
- Use verbose mode, with many diagnostics written to standard output.
- Add new entries. The default for ldapmodify is to modify existing entries. If invoked as ldapadd, this flag is always set.
- Continuous operation mode. Errors are reported, but ldapmodify will continue with modifications. The default is to exit after reporting an error.
- Read the entry modification information from file instead of from standard input.
- Add or change records which were skipped due to an error are written to file and the error message returned by the server is added as a comment. Most useful in conjunction with -c.
- Enable manage DSA IT control. -MM makes control critical.
- Use simple authentication instead of SASL.
- Use the Distinguished Name binddn to bind to the LDAP directory. For SASL binds, the server is expected to ignore this value.
- Prompt for simple authentication. This is used instead of specifying the password on the command line.
- Use passwd as the password for simple authentication.
- Use complete contents of passwdfile as the password for simple authentication.
- Specify 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.
- Specify an alternate host on which the ldap server is running. Deprecated in favor of -H.
- Specify an alternate TCP port where the ldap server is listening. Deprecated in favor of -H.
- Specify the LDAP protocol version to use.
Specify general extensions with -e and modify extensions with -E. '!' 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)
Specify general options.
nettimeout=<timeout> (in seconds, or "none" or "max") ldif-wrap=<width> (in columns, or "no" for no wrapping)
- Specify SASL security properties.
- Enable SASL Interactive mode. Always prompt. Default is to prompt only as needed.
- Enable SASL Quiet mode. Never prompt.
- Do not use reverse DNS to canonicalize SASL host name.
- Specify the authentication ID for SASL bind. The form of the ID depends on the actual SASL mechanism used.
- Specify the realm of authentication ID for SASL bind. The form of the realm depends on the actual SASL mechanism used.
- Specify the requested authorization ID for SASL bind. authzid must be one of the following formats: dn:<distinguished name> or u:<username>
- Specify the SASL mechanism to be used for authentication. If it's not specified, the program will choose the best mechanism the server knows.
- Issue StartTLS (Transport Layer Security) extended operation. If you use -ZZ, the command will require the operation to be successful.
INPUT FORMATThe contents of file (or standard input if no -f flag is given on the command line) must conform to the format defined in ldif(5) (LDIF as defined in RFC 2849).
EXAMPLESAssuming that the file /tmp/entrymods exists and has the contents:
dn: cn=Modify Me,dc=example,dc=com changetype: modify replace: mail mail: modme [at] example.com - add: title title: Grand Poobah - add: jpegPhoto jpegPhoto:< file:///tmp/modme.jpeg - delete: description -
ldapmodify -f /tmp/entrymods
will replace the contents of the "Modify Me" entry's mail attribute with the value "modme [at] example.com", add a title of "Grand Poobah", and the contents of the file "/tmp/modme.jpeg" as a jpegPhoto, and completely remove the description attribute.
Assuming that the file /tmp/newentry exists and has the contents:
dn: cn=Barbara Jensen,dc=example,dc=com objectClass: person cn: Barbara Jensen cn: Babs Jensen sn: Jensen title: the world's most famous mythical manager mail: bjensen [at] example.com uid: bjensen
ldapadd -f /tmp/newentry
will add a new entry for Babs Jensen, using the values from the file /tmp/newentry.
Assuming that the file /tmp/entrymods exists and has the contents:
dn: cn=Barbara Jensen,dc=example,dc=com changetype: delete
ldapmodify -f /tmp/entrymods
will remove Babs Jensen's entry.
DIAGNOSTICSExit status is zero if no errors occur. Errors result in a non-zero exit status and a diagnostic message being written to standard error.
AUTHORThe OpenLDAP Project <http://www.openldap.org/>
ACKNOWLEDGEMENTSOpenLDAP 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.