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

   1 .TH LDAPDELETE 1 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2002 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 \-C ]
  21 [\c
  22 .BR \-M[M] ]
  23 [\c
  24 .BI \-d \ debuglevel\fR]
  25 [\c
  26 .BI \-f \ file\fR]
  27 [\c
  28 .BI \-D \ binddn\fR]
  29 [\c
  30 .BR \-W ]
  31 [\c
  32 .BI \-w \ passwd\fR]
  33 [\c
  34 .BI \-y \ passwdfile\fR]
  35 [\c
  36 .BI \-H \ ldapuri\fR]
  37 [\c
  38 .BI \-h \ ldaphost\fR]
  39 [\c
  40 .BI \-P \ 2\fR\||\|\fI3\fR]
  41 [\c
  42 .BI \-p \ ldapport\fR]
  43 [\c
  44 .BR \-O \ security-properties ]
  45 [\c
  46 .BI \-U \ authcid\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 Automatically chase referrals.
  98 .TP
  99 .B \-c
 100 Continuous operation mode.  Errors  are  reported,  but
 101 .B ldapdelete
 102 will  continue  with  deletions.   The default is to exit after
 103 reporting an error.
 104 .TP
 105 .B \-M[M]
 106 Enable manage DSA IT control.
 107 .B \-MM
 108 makes control critical.
 109 .TP
 110 .BI \-d \ debuglevel
 111 Set the LDAP debugging level to \fIdebuglevel\fP.
 112 .B ldapdelete
 113 must be compiled with LDAP_DEBUG defined for this option to have any effect.
 114 .TP
 115 .BI \-f \ file
 116 Read a series of DNs from \fIfile\fP, one per line, performing an
 117 LDAP delete for each.
 118 .TP
 119 .B \-x
 120 Use simple authentication instead of SASL.
 121 .TP
 122 .BI \-D \ binddn
 123 Use the Distinguished Name \fIbinddn\fP to bind to the LDAP directory.
 124 .TP
 125 .B \-W
 126 Prompt for simple authentication.
 127 This is used instead of specifying the password on the command line.
 128 .TP
 129 .BI \-w \ passwd
 130 Use \fIpasswd\fP as the password for simple authentication.
 131 .TP
 132 .BI \-y \ passwdfile
 133 Use complete contents of \fIpasswdfile\fP as the password for
 134 simple authentication.
 135 .TP
 136 .BI \-H \ ldapuri
 137 Specify URI(s) referring to the ldap server(s).
 138 .TP
 139 .BI \-h \ ldaphost
 140 Specify an alternate host on which the ldap server is running.
 141 Deprecated in favor of -H.
 142 .TP
 143 .BI \-p \ ldapport
 144 Specify an alternate TCP port where the ldap server is listening.
 145 Deprecated in favor of -H.
 146 .TP
 147 .BI \-P \ 2\fR\||\|\fI3
 148 Specify the LDAP protocol version to use.
 149 .TP
 150 .B \-r
 151 Do a recursive delete.  If the DN specified isn't a leaf, its
 152 children, and all their children are deleted down the tree.  No
 153 verification is done, so if you add this switch, ldapdelete will
 154 happily delete large portions of your tree.  Use with care.
 155 .TP
 156 .BI \-O \ security-properties
 157 Specify SASL security properties.
 158 .TP
 159 .B \-I
 160 Enable SASL Interactive mode.  Always prompt.  Default is to prompt
 161 only as needed.
 162 .TP
 163 .B \-Q
 164 Enable SASL Quiet mode.  Never prompt.
 165 .TP
 166 .BI \-U \ authcid
 167 Specify the authentication ID for SASL bind. The form of the identity depends on the
 168 actual SASL mechanism used.
 169 .TP
 170 .BI \-X \ authzid
 171 Specify the requested authorization ID for SASL bind.
 172 .I authzid
 173 must be one of the following formats:
 174 .B dn:\c
 175 .I <distinguished name>
 176 or
 177 .B u:\c
 178 .I <username>
 179 .TP
 180 .BI \-Y \ mech
 181 Specify the SASL mechanism to be used for authentication. If it's not
 182 specified, the program will choose the best mechanism the server knows.
 183 .TP
 184 .B \-Z[Z]
 185 Issue StartTLS (Transport Layer Security) extended operation. If you use
 186 .B \-ZZ\c
 187 , the command will require the operation to be successful.
 188 .SH EXAMPLE
 189 The following command:
 190 .LP
 191 .nf
 192     ldapdelete "cn=Delete Me,dc=example,dc=com"
 193 .fi
 194 .LP
 195 will attempt to delete the entry named "cn=Delete Me,dc=example,dc=com".
 196 Of course it would probably be necessary to supply authentication
 197 credentials.
 198 .SH DIAGNOSTICS
 199 Exit status is 0 if no errors occur.  Errors result in a non-zero exit
 200 status and a diagnostic message being written to standard error.
 201 .SH "SEE ALSO"
 202 .BR ldap.conf (5),
 203 .BR ldapadd (1),
 204 .BR ldapmodify (1),
 205 .BR ldapmodrdn (1),
 206 .BR ldapsearch (1),
 207 .BR ldap (3),
 208 .BR ldap_delete (3)
 209 .SH AUTHOR
 210 The OpenLDAP Project <http://www.openldap.org/>
 211 .SH ACKNOWLEDGEMENTS
 212 .B      OpenLDAP
 213 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 214 .B      OpenLDAP
 215 is derived from University of Michigan LDAP 3.3 Release.