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

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