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

   1 .TH SLAPO-MEMBEROF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 1998-2014 The OpenLDAP Foundation, All Rights Reserved.
   3 .\" Copying restrictions apply.  See the COPYRIGHT file.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapo\-memberof \- Reverse Group Membership overlay to slapd
   7 .SH SYNOPSIS
   8 ETCDIR/slapd.conf
   9 .SH DESCRIPTION
  10 The
  11 .B memberof
  12 overlay to
  13 .BR slapd (8)
  14 allows automatic reverse group membership maintenance.
  15 Any time a group entry is modified, its members are modified as appropriate
  16 in order to keep a DN-valued "is member of" attribute updated with the DN
  17 of the group.
  18
  19 .SH CONFIGURATION
  20 The config directives that are specific to the
  21 .B memberof
  22 overlay must be prefixed by
  23 .BR memberof\- ,
  24 to avoid potential conflicts with directives specific to the underlying
  25 database or to other stacked overlays.
  26
  27 .TP
  28 .B overlay memberof
  29 This directive adds the memberof overlay to the current database; see
  30 .BR slapd.conf (5)
  31 for details.
  32
  33 .LP
  34 The following
  35 .B slapd.conf
  36 configuration options are defined for the memberof overlay.
  37
  38 .TP
  39 .BI memberof\-group\-oc \ <group-oc>
  40 The value
  41 .I <group-oc>
  42 is the name of the objectClass that triggers the reverse group membership
  43 update.
  44 It defaults to \fIgroupOfNames\fP.
  45
  46 .TP
  47 .BI memberof\-member\-ad \ <member-ad>
  48 The value
  49 .I <member-ad>
  50 is the name of the attribute that contains the names of the members
  51 in the group objects; it must be DN-valued.
  52 It defaults to \fImember\fP.
  53
  54 .TP
  55 .BI memberof\-memberof\-ad \ <memberof-ad>
  56 The value
  57 .I <memberof-ad>
  58 is the name of the attribute that contains the names of the groups
  59 an entry is member of; it must be DN-valued.  Its contents are
  60 automatically updated by the overlay.
  61 It defaults to \fImemberOf\fP.
  62
  63 .TP
  64 .BI memberof\-dn \ <dn>
  65 The value
  66 .I <dn>
  67 contains the DN that is used as \fImodifiersName\fP for internal
  68 modifications performed to update the reverse group membership.
  69 It defaults to the \fIrootdn\fP of the underlying database.
  70
  71 .TP
  72 .BI "memberof\-dangling {" ignore ", " drop ", " error "}"
  73 This option determines the behavior of the overlay when, during
  74 a modification, it encounters dangling references.
  75 The default is
  76 .IR ignore ,
  77 which may leave dangling references.
  78 Other options are
  79 .IR drop ,
  80 which discards those modifications that would result in dangling
  81 references, and
  82 .IR error ,
  83 which causes modifications that would result in dangling references
  84 to fail.
  85
  86 .TP
  87 .BI memberof\-dangling\-error \ <error-code>
  88 If
  89 .BR memberof\-dangling
  90 is set to
  91 .IR error ,
  92 this configuration parameter can be used to modify the response code
  93 returned in case of violation.  It defaults to "constraint violation",
  94 but other implementations are known to return "no such object" instead.
  95
  96 .TP
  97 .BI "memberof\-refint {" true "|" FALSE "}"
  98 This option determines whether the overlay will try to preserve
  99 referential integrity or not.
 100 If set to
 101 .IR TRUE ,
 102 when an entry containing values of the "is member of" attribute is modified,
 103 the corresponding groups are modified as well.
 104
 105 .LP
 106 The memberof overlay may be used with any backend that provides full
 107 read-write functionality, but it is mainly intended for use
 108 with local storage backends. The maintenance operations it performs
 109 are internal to the server on which the overlay is configured and
 110 are never replicated. Replica servers should be configured with their
 111 own instances of the memberOf overlay if it is desired to maintain
 112 these memberOf attributes on the replicas.
 113
 114 .SH FILES
 115 .TP
 116 ETCDIR/slapd.conf
 117 default slapd configuration file
 118 .SH SEE ALSO
 119 .BR slapd.conf (5),
 120 .BR slapd\-config (5),
 121 .BR slapd (8).
 122 The
 123 .BR slapo\-memberof (5)
 124 overlay supports dynamic configuration via
 125 .BR back-config .
 126 .SH ACKNOWLEDGEMENTS
 127 .P
 128 This module was written in 2005 by Pierangelo Masarati for SysNet s.n.c.
 129