git.sur5r.net Git - openldap/blob - doc/man/man5/slapd.replog.5

   1 .TH SLAPD.REPLOG 5 "22 September 1998" "OpenLDAP LDVERSION"
   2 .SH NAME
   3 slapd.replog \- slapd replication log format
   4 .SH SYNOPSIS
   5 slapd.replog
   6 slapd.replog.lock
   7 .SH DESCRIPTION
   8 .LP
   9 The file slapd.replog is produced by the stand-alone LDAP daemon,
  10 .IR slapd ,
  11 when changes are made to its local database that are to be
  12 propagated to one or more replica
  13 .IR slapd s.
  14 The file consists of
  15 zero or more records, each one corresponding to a change, addition,
  16 or deletion from the
  17 .I slapd
  18 database.  The file is meant to be read
  19 and processed by
  20 .IR slurpd ,
  21 the stand-alone LDAP update replication daemon.  The records are
  22 separated by a blank line.  Each record has the following format.
  23 .LP
  24 The record begins with one or more lines indicating the replicas
  25 to which the change is to be propagated:
  26 .LP
  27 .nf
  28         replica: <hostname[:portnumber]>
  29 .fi
  30 .LP
  31 Next, the time the change took place given, as the number of seconds since
  32 00:00:00 GMT, Jan. 1, 1970, with an optional decimal extension, in order
  33 to make times unique.  Note that slapd does not make times unique, but
  34 slurpd makes all times unique in its copies of the replog files.
  35 .LP
  36 .nf
  37         time: <integer[.integer]>
  38 .fi
  39 .LP
  40 Next, the distinguished name of the entry being changed is given:
  41 .LP
  42 .nf
  43         dn: <distinguishedname>
  44 .fi
  45 .LP
  46 Next, the type of change being made is given:
  47 .LP
  48 .nf
  49         changetype: <[modify|add|delete|modrdn]>
  50 .fi
  51 .LP
  52 Finally, the change information itself is given, the format of which
  53 depends on what kind of change was specified above.  For a \fIchangetype\fP
  54 of \fImodify\fP, the format is one or more of the following:
  55 .LP
  56 .nf
  57         add: <attributetype>
  58         <attributetype>: <value1>
  59         <attributetype>: <value2>
  60         ...
  61         -
  62 .fi
  63 .LP
  64 Or, for a replace modification:
  65 .LP
  66 .nf
  67         replace: <attributetype>
  68         <attributetype>: <value1>
  69         <attributetype>: <value2>
  70         ...
  71         -
  72 .fi
  73 .LP
  74 Or, for a delete modification:
  75 .LP
  76 .nf
  77         delete: <attributetype>
  78         <attributetype>: <value1>
  79         <attributetype>: <value2>
  80         ...
  81         -
  82 .fi
  83 .LP
  84 If no \fIattributetype\fP lines are given, the entire attribute is to be
  85 deleted.
  86 .LP
  87 For a \fIchangetype\fP of \fIadd\fP, the format is:
  88 .LP
  89 .nf
  90         <attributetype1>: <value1>
  91         <attributetype1>: <value2>
  92         ...
  93         <attributetypeN>: <value1>
  94         <attributetypeN>: <value2>
  95 .fi
  96 .LP
  97 For a \fIchangetype\fP of \fImodrdn\fP, the format is:
  98 .LP
  99 .nf
 100         newrdn: <newrdn>
 101         deleteoldrdn: 0 | 1
 102 .fi
 103 .LP
 104 where a value of 1 for deleteoldrdn means to delete the values
 105 forming the old rdn from the entry, and a value of 0 means to
 106 leave the values as non-distinguished attributes in the entry.
 107 .LP
 108 For a \fIchangetype\fP of \fIdelete\fP, no additional information
 109 is needed in the record.
 110 .LP
 111 The format of the values is the LDAP Directory Interchange Format
 112 described in
 113 .BR ldif (5).
 114 .LP
 115 Access to the \fIslapd.replog\fP file is synchronized through the
 116 use of
 117 .BR flock (3)
 118 on the file \fIslapd.replog.lock\fP.  Any process
 119 reading or writing this file should obey this locking convention.
 120 .SH EXAMPLE
 121 The following sample \fIslapd.replog\fP file contains information
 122 on one of each type of change.
 123 .LP
 124 .nf
 125         replica: truelies.rs.itd.umich.edu
 126         replica: judgmentday.rs.itd.umich.edu
 127         time: 797612941
 128         dn: cn=Babs Jensen, o=U of M, c=US
 129         changetype: add
 130         objectclass: person
 131         cn: babs
 132         cn: babs jensen
 133         sn: jensen
 134
 135         replica: truelies.rs.itd.umich.edu
 136         replica: judgmentday.rs.itd.umich.edu
 137         time: 797612973
 138         dn: cn=Babs Jensen, o=U of M, c=US
 139         changetype: modify
 140         add: description
 141         description: the fabulous babs
 142
 143         replica: truelies.rs.itd.umich.edu
 144         replica: judgmentday.rs.itd.umich.edu
 145         time: 797613020
 146         dn: cn=Babs Jensen, o=U of M, c=US
 147         changetype: modrdn
 148         newrdn: cn=Barbara J Jensen
 149         deleteoldrdn: 0
 150 .fi
 151 .SH FILES
 152 slapd.replog
 153 slapd.replog.lock
 154 .SH SEE ALSO
 155 .BR ldap (3),
 156 .BR ldif (5),
 157 .BR slapd (8),
 158 .BR slurpd (8)
 159 .SH ACKNOWLEDGEMENTS
 160 .B      OpenLDAP
 161 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 162 .B      OpenLDAP
 163 is derived from University of Michigan LDAP 3.3 Release.