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

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