X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=doc%2Fman%2Fman1%2Fldapmodify.1;h=026801294699a43bffba4a853d4e280d27c86d4f;hb=dac408369b0812762b3e85f7e024ea472ce79abc;hp=7f9c4fbf719c263d8caa56633c12fd21717eb645;hpb=de6ed4fde440bf859ca184d93fa474f7e519f804;p=openldap diff --git a/doc/man/man1/ldapmodify.1 b/doc/man/man1/ldapmodify.1 index 7f9c4fbf71..0268012946 100644 --- a/doc/man/man1/ldapmodify.1 +++ b/doc/man/man1/ldapmodify.1 @@ -1,6 +1,6 @@ .TH LDAPMODIFY 1 "RELEASEDATE" "OpenLDAP LDVERSION" .\" $OpenLDAP$ -.\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved. +.\" Copyright 1998-2011 The OpenLDAP Foundation All Rights Reserved. .\" Copying restrictions apply. See COPYRIGHT/LICENSE. .SH NAME ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools @@ -17,11 +17,7 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools [\c .BR \-v ] [\c -.BR \-k ] -[\c -.BR \-K ] -[\c -.BR \-M[M] ] +.BR \-M [ M ]] [\c .BI \-d \ debuglevel\fR] [\c @@ -39,9 +35,13 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools [\c .BI \-p \ ldapport\fR] [\c -.BI \-P \ 2\fR\||\|\fI3\fR] +.BR \-P \ { 2 \||\| 3 }] +[\c +.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]] +[\c +.BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]] [\c -.BR \-O \ security-properties ] +.BI \-O \ security-properties\fR] [\c .BR \-I ] [\c @@ -57,7 +57,7 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools [\c .BI \-Y \ mech\fR] [\c -.BR \-Z[Z] ] +.BR \-Z [ Z ]] [\c .BI \-f \ file\fR] .LP @@ -71,11 +71,7 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools [\c .BR \-v ] [\c -.BR \-k ] -[\c -.BR \-K ] -[\c -.BR \-M[M] ] +.BR \-M [ M ]] [\c .BI \-d \ debuglevel\fR] [\c @@ -87,13 +83,15 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools [\c .BI \-y \ passwdfile\fR] [\c +.BI \-H \ ldapuri\fR] +[\c .BI \-h \ ldaphost\fR] [\c .BI \-p \ ldapport\fR] [\c -.BI \-P \ 2\fR\||\|\fI3\fR] +.BR \-P \ { 2 \||\| 3 }] [\c -.BR \-O \ security-properties ] +.BI \-O \ security-properties\fR] [\c .BR \-I ] [\c @@ -109,25 +107,27 @@ ldapmodify, ldapadd \- LDAP modify entry and LDAP add entry tools [\c .BI \-Y \ mech\fR] [\c -.BR \-Z[Z] ] +.BR \-Z [ Z ]] [\c .BI \-f \ file\fR] .SH DESCRIPTION .B ldapmodify is a shell-accessible interface to the -.BR ldap_modify (3) +.BR ldap_add_ext (3), +.BR ldap_modify_ext (3), +.BR ldap_delete_ext (3) and -.BR ldap_add (3) +.BR ldap_rename (3). library calls. .B ldapadd is implemented as a hard link to the ldapmodify tool. When invoked as .B ldapadd -the -a (add new entry) flag is turned on automatically. +the \fB\-a\fP (add new entry) flag is turned on automatically. .LP .B ldapmodify opens a connection to an LDAP server, binds, and modifies or adds entries. The entry information is read from standard input or from \fIfile\fP through -the use of the -f option. +the use of the \fB\-f\fP option. .SH OPTIONS .TP .B \-a @@ -146,33 +146,16 @@ reporting an error. .BI \-S \ file Add or change records which where skipped due to an error are written to \fIfile\fP and the error message returned by the server is added as a comment. Most useful in -conjunction with -c. +conjunction with \fB\-c\fP. .TP .B \-n Show what would be done, but don't actually modify entries. Useful for -debugging in conjunction with -v. +debugging in conjunction with \fB\-v\fP. .TP .B \-v Use verbose mode, with many diagnostics written to standard output. .TP -.B \-k -Use Kerberos IV authentication instead of simple authentication. It is -assumed that you already have a valid ticket granting ticket. You must -compile with Kerberos support for this option to have any effect. -.TP -.B \-K -Same as \-k, but only does step 1 of the Kerberos IV bind. This is useful -when connecting to a slapd and there is no x500dsa.hostname principal -registered with your Kerberos Domain Controller(s). -.TP -.B \-F -Force application of all changes regardless of the contents of input -lines that begin with -.I replica: -(by default, replica: lines are compared against the LDAP server host -and port in use to decide if a replog record should actually be applied). -.TP -.B \-M[M] +.BR \-M [ M ] Enable manage DSA IT control. .B \-MM makes control critical. @@ -191,6 +174,7 @@ Use simple authentication instead of SASL. .TP .BI \-D \ binddn Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory. +For SASL binds, the server is expected to ignore this value. .TP .B \-W Prompt for simple authentication. @@ -204,22 +188,54 @@ Use complete contents of \fIpasswdfile\fP as the password for simple authentication. .TP .BI \-H \ ldapuri -Specify URI(s) referring to the ldap server(s). +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. .TP .BI \-h \ ldaphost Specify an alternate host on which the ldap server is running. -Deprecated in favor of -H. +Deprecated in favor of \fB\-H\fP. .TP .BI \-p \ ldapport Specify an alternate TCP port where the ldap server is listening. -Deprecated in favor of -H. +Deprecated in favor of \fB\-H\fP. .TP -.BI \-P \ 2\fR\||\|\fI3 +.BR \-P \ { 2 \||\| 3 } Specify the LDAP protocol version to use. .TP .BI \-O \ security-properties Specify SASL security properties. .TP +.BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ] +.TP +.BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ] + +Specify general extensions with \fB\-e\fP and modify extensions with \fB\-E\fP. +\'\fB!\fP\' indicates criticality. + +General extensions: +.nf + [!]assert= (an RFC 4515 Filter) + !authzid= ("dn:" or "u:") + [!]bauthzid (RFC 3829 authzid control) + [!]chaining[=[/]] + [!]manageDSAit + [!]noop + ppolicy + [!]postread[=] (a comma-separated attribute list) + [!]preread[=] (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) +.fi + +Modify extensions: +.nf + [!]txn[=abort|commit] +.fi +.TP .B \-I Enable SASL Interactive mode. Always prompt. Default is to prompt only as needed. @@ -239,53 +255,23 @@ depends on the actual SASL mechanism used. Specify the requested authorization ID for SASL bind. .I authzid must be one of the following formats: -.B dn:\c -.I +.BI dn: "" or -.B u:\c -.I +.BI u: .TP .BI \-Y \ mech Specify the SASL mechanism to be used for authentication. If it's not specified, the program will choose the best mechanism the server knows. .TP -.B \-Z[Z] +.BR \-Z [ Z ] Issue StartTLS (Transport Layer Security) extended operation. If you use .B \-ZZ\c , the command will require the operation to be successful. .SH INPUT FORMAT -The contents of \fIfile\fP (or standard input if no \-f flag is given on -the command line) should conform to the format defined in -.BR slapd.replog (5), -with the exceptions noted below. -.LP -Lines that begin with "replica:" are matched against the LDAP server host -and port in use to decide if a particular replog record should be applied. -Any other lines that precede the "dn:" line are ignored. -The -F flag can be used to force -.I ldapmodify -to apply all of the replog changes, regardless of the presence or -absence of any "replica:" lines. -.LP -If no "changetype:" line is present, the default is "add" if the -a -flag is set (or if the program was invoked as -.I ldapmodify) -and "modify" otherwise. -.LP -If changetype is "modify" and no "add:", "replace:", or "delete:" lines -appear, the default is "replace" for and "add" -.BR ldapmodify (1) -for -.BR ldapadd (1). -.LP -Note that the above exceptions to the -.BR slapd.replog (5) -format allow +The contents of \fIfile\fP (or standard input if no \fB\-f\fP flag is given on +the command line) must conform to the format defined in .BR ldif (5) -entries to be used as input to -.I ldapmodify -or -.I ldapadd. +(LDIF as defined in RFC 2849). .SH EXAMPLES Assuming that the file .B /tmp/entrymods @@ -295,22 +281,22 @@ exists and has the contents: dn: cn=Modify Me,dc=example,dc=com changetype: modify replace: mail - mail: modme@OpenLDAP.org - - + mail: modme@example.com + \- add: title title: Grand Poobah - - + \- add: jpegPhoto - jpegPhoto:< file://tmp/modme.jpeg - - + jpegPhoto:< file:///tmp/modme.jpeg + \- delete: description - - + \- .fi .LP the command: .LP .nf - ldapmodify -f /tmp/entrymods + ldapmodify \-f /tmp/entrymods .fi .LP will replace the contents of the "Modify Me" entry's @@ -337,11 +323,12 @@ exists and has the contents: title: the world's most famous mythical manager mail: bjensen@example.com uid: bjensen +.fi .LP the command: .LP .nf - ldapadd -f /tmp/entrymods + ldapadd \-f /tmp/newentry .fi .LP will add a new entry for Babs Jensen, using the values from the @@ -349,17 +336,18 @@ file .B /tmp/newentry. .LP Assuming that the file -.B /tmp/newentry +.B /tmp/entrymods exists and has the contents: .LP .nf dn: cn=Barbara Jensen,dc=example,dc=com changetype: delete +.fi .LP the command: .LP .nf - ldapmodify -f /tmp/entrymods + ldapmodify \-f /tmp/entrymods .fi .LP will remove Babs Jensen's entry. @@ -373,15 +361,13 @@ exit status and a diagnostic message being written to standard error. .BR ldapsearch (1), .BR ldap.conf (5), .BR ldap (3), -.BR ldap_add (3), -.BR ldap_delete (3), -.BR ldap_modify (3), -.BR ldap_modrdn (3), +.BR ldap_add_ext (3), +.BR ldap_delete_ext (3), +.BR ldap_modify_ext (3), +.BR ldap_modrdn_ext (3), +.BR ldif (5), .BR slapd.replog (5) .SH AUTHOR The OpenLDAP Project .SH ACKNOWLEDGEMENTS -.B OpenLDAP -is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). -.B OpenLDAP -is derived from University of Michigan LDAP 3.3 Release. +.so ../Project