git.sur5r.net Git - openldap/blob - doc/man/man5/slapo-refint.5

   1 .TH SLAPO-REFINT 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2004-2017 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapo\-refint \- Referential Integrity overlay to slapd
   7 .SH SYNOPSIS
   8 ETCDIR/slapd.conf
   9 .SH DESCRIPTION
  10 The Referential Integrity overlay can be used with a backend database such as
  11 .BR slapd\-bdb (5)
  12 to maintain the cohesiveness of a schema which utilizes reference attributes.
  13 .LP
  14 Integrity is maintained by updating database records which contain the named
  15 attributes to match the results of a
  16 .B modrdn
  17 or
  18 .B delete
  19 operation. For example, if the integrity attribute were configured as
  20 .BR manager ,
  21 deletion of the record "uid=robert,ou=people,dc=example,dc=com" would trigger a
  22 search for all other records which have a
  23 .B manager
  24 attribute containing that DN. Entries matching that search would have their
  25 .B manager
  26 attribute removed.
  27 Or, renaming the same record into "uid=george,ou=people,dc=example,dc=com"
  28 would trigger a search for all other records which have a
  29 .B manager
  30 attribute containing that DN.
  31 Entries matching that search would have their
  32 .B manager
  33 attribute deleted and replaced by the new DN.
  34 .LP
  35 .B rootdn
  36 must be set for the database.  refint runs as the rootdn
  37 to gain access to make its updates.
  38 .B rootpw
  39 is not needed.
  40 .SH CONFIGURATION
  41 These
  42 .B slapd.conf
  43 options apply to the Referential Integrity overlay.
  44 They should appear after the
  45 .B overlay
  46 directive.
  47 .TP
  48 .B refint_attributes <attribute> [...]
  49 Specify one or more attributes for which integrity will be maintained
  50 as described above.
  51 .TP
  52 .B refint_nothing <string>
  53 Specify an arbitrary value to be used as a placeholder when the last value
  54 would otherwise be deleted from an attribute. This can be useful in cases
  55 where the schema requires the existence of an attribute for which referential
  56 integrity is enforced. The attempted deletion of a required attribute will
  57 otherwise result in an Object Class Violation, causing the request to fail.
  58 The string must be a valid DN.
  59 .TP
  60 .B refint_modifiersname <DN>
  61 Specify the DN to be used as the modifiersName of the internal modifications
  62 performed by the overlay.
  63 It defaults to "\fIcn=Referential Integrity Overlay\fP".
  64 .LP
  65 Modifications performed by this overlay are not propagated during
  66 replication. This overlay must be configured identically on
  67 replication consumers in order to maintain full synchronization
  68 with the provider.
  69
  70 .SH FILES
  71 .TP
  72 ETCDIR/slapd.conf
  73 default slapd configuration file
  74 .SH SEE ALSO
  75 .BR slapd.conf (5),
  76 .BR slapd\-config (5).
  77 .SH ACKNOWLEDGEMENTS
  78 .so ../Project