1SLAPO-SYNCPROV(5)             File Formats Manual            SLAPO-SYNCPROV(5)
2
3
4

NAME

6       slapo-syncprov - Sync Provider overlay to slapd
7

SYNOPSIS

9       /etc/openldap/slapd.conf
10

DESCRIPTION

12       The  Sync Provider overlay implements the provider-side support for the
13       LDAP Content Synchronization (RFC4533) as well as syncrepl  replication
14       support.   The  overlay  can  be  used  with any backend that maintains
15       entryCSN and entryUUID attributes for its entries. It  also  creates  a
16       contextCSN attribute in the root entry of the database.
17
18       The  contextCSN  is updated for every write operation performed against
19       the database. To reduce database contention,  the  contextCSN  is  only
20       updated in memory. The value is written to the database on server shut‐
21       down and read into memory on startup, and maintained in  memory  there‐
22       after.  Checkpoints  may be configured to write the contextCSN into the
23       underlying database to minimize recovery time after  an  unclean  shut‐
24       down.
25
26       On  databases that support inequality indexing, it is helpful to set an
27       eq index on the entryCSN attribute when using this overlay.
28

CONFIGURATION

30       These slapd.conf options apply to  the  Sync  Provider  overlay.   They
31       should appear after the overlay directive.
32
33       syncprov-checkpoint <ops> <minutes>
34              After  a  write operation has succeeded, write the contextCSN to
35              the underlying database if <ops> write operations or  more  than
36              <minutes>  time  have  passed  since the last checkpoint. Check‐
37              pointing is disabled by default.
38
39       syncprov-sessionlog <ops>
40              Configures an in-memory session log  for  recording  information
41              about  write  operations made on the database.  The <ops> speci‐
42              fies the number of operations that are recorded in the log.  All
43              write  operations  (except  Adds) are recorded in the log.  When
44              using the session log, it is helpful to set an eq index  on  the
45              entryUUID attribute in the underlying database.
46
47       syncprov-nopresent TRUE | FALSE
48              Specify  that the Present phase of refreshing should be skipped.
49              This value should only be set TRUE for a  syncprov  instance  on
50              top  of  a  log  database  (such as one managed by the accesslog
51              overlay).  The default is FALSE.
52
53       syncprov-reloadhint TRUE | FALSE
54              Specify that the overlay should honor the reloadHint flag in the
55              Sync  Control.  In OpenLDAP releases 2.3.11 and earlier the syn‐
56              crepl consumer did not properly set this flag,  so  the  overlay
57              must ignore it. This option should be set TRUE when working with
58              newer releases that properly support this flag. It must  be  set
59              TRUE  when  using the accesslog overlay for delta-based syncrepl
60              replication support.  The default is FALSE.
61

FILES

63       /etc/openldap/slapd.conf
64              default slapd configuration file
65

SEE ALSO

67       slapd.conf(5), slapd-config(5), slapo-accesslog(5).  OpenLDAP  Adminis‐
68       trator's Guide.
69

ACKNOWLEDGEMENTS

71       OpenLDAP  Software  is developed and maintained by The OpenLDAP Project
72       <http://www.openldap.org/>.  OpenLDAP Software is derived from  Univer‐
73       sity of Michigan LDAP 3.3 Release.
74
75
76
77OpenLDAP 2.4.44                   2016/02/05                 SLAPO-SYNCPROV(5)
Impressum