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 en‐
15       tryCSN and entryUUID attributes for its entries. It also creates a con‐
16       textCSN 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 up‐
20       dated  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 highly recommended
27       to set an 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-sessionlog-source <dn>
48              Should  not  be  set  when  syncprov-sessionlog  is set and vice
49              versa.
50
51              When accesslog for this database is configured and is logging at
52              this suffix, it can be used as the session log source instead of
53              the in-memory session log mentioned above. This log has the  ad‐
54              vantage  of  not  starting  afresh  every  time  the  server  is
55              restarted.
56
57       syncprov-nopresent TRUE | FALSE
58              Specify that the Present phase of refreshing should be  skipped.
59              This  value  should  only be set TRUE for a syncprov instance on
60              top of a log database (such as  one  managed  by  the  accesslog
61              overlay).  The default is FALSE.
62
63       syncprov-reloadhint TRUE | FALSE
64              Specify that the overlay should honor the reloadHint flag in the
65              Sync Control. It must be set TRUE when using the accesslog over‐
66              lay  for  delta-based syncrepl replication support.  The default
67              is FALSE.
68

FILES

70       /etc/openldap/slapd.conf
71              default slapd configuration file
72

SEE ALSO

74       slapd.conf(5), slapd-config(5), slapo-accesslog(5).  OpenLDAP  Adminis‐
75       trator's Guide.
76

ACKNOWLEDGEMENTS

78       OpenLDAP  Software  is developed and maintained by The OpenLDAP Project
79       <http://www.openldap.org/>.  OpenLDAP Software is derived from the Uni‐
80       versity of Michigan LDAP 3.3 Release.
81
82
83
84OpenLDAP 2.6.2                    2022/05/04                 SLAPO-SYNCPROV(5)
Impressum