git.sur5r.net Git - openldap/blob - doc/man/man1/ldapdelete.1

   1 .TH LDAPDELETE 1 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2003 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldapdelete \- LDAP delete entry tool
   7 .SH SYNOPSIS
   8 .B ldapdelete
   9 [\c
  10 .BR \-n ]
  11 [\c
  12 .BR \-v ]
  13 [\c
  14 .BR \-k ]
  15 [\c
  16 .BR \-K ]
  17 [\c
  18 .BR \-c ]
  19 [\c
  20 .BR \-M[M] ]
  21 [\c
  22 .BI \-d \ debuglevel\fR]
  23 [\c
  24 .BI \-f \ file\fR]
  25 [\c
  26 .BI \-D \ binddn\fR]
  27 [\c
  28 .BR \-W ]
  29 [\c
  30 .BI \-w \ passwd\fR]
  31 [\c
  32 .BI \-y \ passwdfile\fR]
  33 [\c
  34 .BI \-H \ ldapuri\fR]
  35 [\c
  36 .BI \-h \ ldaphost\fR]
  37 [\c
  38 .BI \-P \ 2\fR\||\|\fI3\fR]
  39 [\c
  40 .BI \-p \ ldapport\fR]
  41 [\c
  42 .BR \-O \ security-properties ]
  43 [\c
  44 .BI \-U \ authcid\fR]
  45 [\c
  46 .BI \-R \ realm\fR]
  47 [\c
  48 .BR \-x ]
  49 [\c
  50 .BR \-I ]
  51 [\c
  52 .BR \-Q ]
  53 [\c
  54 .BI \-X \ authzid\fR]
  55 [\c
  56 .BI \-Y \ mech\fR]
  57 [\c
  58 .BR \-Z[Z] ]
  59 [\c
  60 .IR dn ]...
  61 .SH DESCRIPTION
  62 .I ldapdelete
  63 is a shell-accessible interface to the
  64 .BR ldap_delete (3)
  65 library call.
  66 .LP
  67 .B ldapdelete
  68 opens a connection to an LDAP server, binds, and deletes one or more
  69 entries.  If one or more \fIDN\fP arguments are provided, entries with
  70 those Distinguished Names are deleted.  Each \fIDN\fP should be provided
  71 using the LDAPv3 string representation as defined in RFC 2253.
  72 If no \fIdn\fP arguments
  73 are provided, a list of DNs is read from standard input (or from
  74 \fIfile\fP if the -f flag is used).
  75 .SH OPTIONS
  76 .TP
  77 .B \-n
  78 Show what would be done, but don't actually delete entries.  Useful for
  79 debugging in conjunction with -v.
  80 .TP
  81 .B \-v
  82 Use verbose mode, with many diagnostics written to standard output.
  83 .TP
  84 .B \-k
  85 Use Kerberos IV authentication instead of simple authentication.  It is
  86 assumed that you already have a valid ticket granting ticket. This option
  87 only has effect if
  88 .B ldapdelete
  89 is compiled with Kerberos support.
  90 .TP
  91 .B \-K
  92 Same as \-k, but only does step 1 of the Kerberos IV bind.  This is useful
  93 when connecting to a slapd and there is no x500dsa.hostname principal
  94 registered with your Kerberos Domain Controller(s).
  95 .TP
  96 .B \-c
  97 Continuous operation mode.  Errors  are  reported,  but
  98 .B ldapdelete
  99 will  continue  with  deletions.   The default is to exit after
 100 reporting an error.
 101 .TP
 102 .B \-M[M]
 103 Enable manage DSA IT control.
 104 .B \-MM
 105 makes control critical.
 106 .TP
 107 .BI \-d \ debuglevel
 108 Set the LDAP debugging level to \fIdebuglevel\fP.
 109 .B ldapdelete
 110 must be compiled with LDAP_DEBUG defined for this option to have any effect.
 111 .TP
 112 .BI \-f \ file
 113 Read a series of DNs from \fIfile\fP, one per line, performing an
 114 LDAP delete for each.
 115 .TP
 116 .B \-x
 117 Use simple authentication instead of SASL.
 118 .TP
 119 .BI \-D \ binddn
 120 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 121 .TP
 122 .B \-W
 123 Prompt for simple authentication.
 124 This is used instead of specifying the password on the command line.
 125 .TP
 126 .BI \-w \ passwd
 127 Use \fIpasswd\fP as the password for simple authentication.
 128 .TP
 129 .BI \-y \ passwdfile
 130 Use complete contents of \fIpasswdfile\fP as the password for
 131 simple authentication.
 132 .TP
 133 .BI \-H \ ldapuri
 134 Specify URI(s) referring to the ldap server(s).
 135 .TP
 136 .BI \-h \ ldaphost
 137 Specify an alternate host on which the ldap server is running.
 138 Deprecated in favor of -H.
 139 .TP
 140 .BI \-p \ ldapport
 141 Specify an alternate TCP port where the ldap server is listening.
 142 Deprecated in favor of -H.
 143 .TP
 144 .BI \-P \ 2\fR\||\|\fI3
 145 Specify the LDAP protocol version to use.
 146 .TP
 147 .B \-r
 148 Do a recursive delete.  If the DN specified isn't a leaf, its
 149 children, and all their children are deleted down the tree.  No
 150 verification is done, so if you add this switch, ldapdelete will
 151 happily delete large portions of your tree.  Use with care.
 152 .TP
 153 .BI \-O \ security-properties
 154 Specify SASL security properties.
 155 .TP
 156 .B \-I
 157 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 158 only as needed.
 159 .TP
 160 .B \-Q
 161 Enable SASL Quiet mode.  Never prompt.
 162 .TP
 163 .BI \-U \ authcid
 164 Specify the authentication ID for SASL bind. The form of the identity depends on the
 165 actual SASL mechanism used.
 166 .TP
 167 .BI \-R \ realm
 168 Specify the realm of authentication ID for SASL bind. The form of the realm
 169 depends on the actual SASL mechanism used.
 170 .TP
 171 .BI \-X \ authzid
 172 Specify the proxy authorization ID for SASL bind.
 173 .I authzid
 174 must be one of the following formats:
 175 .B dn:\c
 176 .I <distinguished name>
 177 or
 178 .B u:\c
 179 .I <username>
 180 .TP
 181 .BI \-Y \ mech
 182 Specify the SASL mechanism to be used for authentication. If it's not
 183 specified, the program will choose the best mechanism the server knows.
 184 .TP
 185 .B \-Z[Z]
 186 Issue StartTLS (Transport Layer Security) extended operation. If you use
 187 .B \-ZZ\c
 188 , the command will require the operation to be successful.
 189 .SH EXAMPLE
 190 The following command:
 191 .LP
 192 .nf
 193     ldapdelete "cn=Delete Me,dc=example,dc=com"
 194 .fi
 195 .LP
 196 will attempt to delete the entry named "cn=Delete Me,dc=example,dc=com".
 197 Of course it would probably be necessary to supply authentication
 198 credentials.
 199 .SH DIAGNOSTICS
 200 Exit status is 0 if no errors occur.  Errors result in a non-zero exit
 201 status and a diagnostic message being written to standard error.
 202 .SH "SEE ALSO"
 203 .BR ldap.conf (5),
 204 .BR ldapadd (1),
 205 .BR ldapmodify (1),
 206 .BR ldapmodrdn (1),
 207 .BR ldapsearch (1),
 208 .BR ldap (3),
 209 .BR ldap_delete (3)
 210 .SH AUTHOR
 211 The OpenLDAP Project <http://www.openldap.org/>
 212 .SH ACKNOWLEDGEMENTS
 213 .B      OpenLDAP
 214 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 215 .B      OpenLDAP
 216 is derived from University of Michigan LDAP 3.3 Release.