slapo-memberof.5 4.16 KB
Newer Older
Pierangelo Masarati's avatar
Pierangelo Masarati committed
1
.TH SLAPO-MEMBEROF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
2
.\" Copyright 1998-2020 The OpenLDAP Foundation, All Rights Reserved.
Pierangelo Masarati's avatar
Pierangelo Masarati committed
3
4
5
.\" Copying restrictions apply.  See the COPYRIGHT file.
.\" $OpenLDAP$
.SH NAME
Howard Chu's avatar
Howard Chu committed
6
slapo\-memberof \- Reverse Group Membership overlay to slapd
Pierangelo Masarati's avatar
Pierangelo Masarati committed
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
.SH SYNOPSIS
ETCDIR/slapd.conf
.SH DESCRIPTION
The
.B memberof
overlay to
.BR slapd (8)
allows automatic reverse group membership maintenance.
Any time a group entry is modified, its members are modified as appropriate
in order to keep a DN-valued "is member of" attribute updated with the DN
of the group.

.SH CONFIGURATION
The config directives that are specific to the
.B memberof
overlay must be prefixed by
.BR memberof\- ,
to avoid potential conflicts with directives specific to the underlying 
database or to other stacked overlays.

.TP
.B overlay memberof
This directive adds the memberof overlay to the current database; see
.BR slapd.conf (5)
for details.

.LP
The following
.B slapd.conf
36
configuration options are defined for the memberof overlay.
Pierangelo Masarati's avatar
Pierangelo Masarati committed
37
38

.TP
Howard Chu's avatar
Howard Chu committed
39
.BI memberof\-group\-oc \ <group-oc>
Pierangelo Masarati's avatar
Pierangelo Masarati committed
40
The value 
41
.I <group-oc> 
Pierangelo Masarati's avatar
Pierangelo Masarati committed
42
43
44
45
46
is the name of the objectClass that triggers the reverse group membership
update.
It defaults to \fIgroupOfNames\fP.

.TP
Howard Chu's avatar
Howard Chu committed
47
.BI memberof\-member\-ad \ <member-ad>
Pierangelo Masarati's avatar
Pierangelo Masarati committed
48
The value 
49
.I <member-ad> 
Pierangelo Masarati's avatar
Pierangelo Masarati committed
50
51
52
53
54
is the name of the attribute that contains the names of the members
in the group objects; it must be DN-valued.
It defaults to \fImember\fP.

.TP
Howard Chu's avatar
Howard Chu committed
55
.BI memberof\-memberof\-ad \ <memberof-ad>
Pierangelo Masarati's avatar
Pierangelo Masarati committed
56
The value 
57
.I <memberof-ad> 
Pierangelo Masarati's avatar
Pierangelo Masarati committed
58
59
60
61
62
63
is the name of the attribute that contains the names of the groups
an entry is member of; it must be DN-valued.  Its contents are 
automatically updated by the overlay.
It defaults to \fImemberOf\fP.

.TP
Howard Chu's avatar
Howard Chu committed
64
.BI memberof\-dn \ <dn>
Pierangelo Masarati's avatar
Pierangelo Masarati committed
65
The value 
66
.I <dn> 
Pierangelo Masarati's avatar
Pierangelo Masarati committed
67
68
69
70
71
contains the DN that is used as \fImodifiersName\fP for internal 
modifications performed to update the reverse group membership.
It defaults to the \fIrootdn\fP of the underlying database.

.TP
Howard Chu's avatar
Howard Chu committed
72
.BI "memberof\-dangling {" ignore ", " drop ", " error "}"
Pierangelo Masarati's avatar
Pierangelo Masarati committed
73
74
75
This option determines the behavior of the overlay when, during 
a modification, it encounters dangling references.
The default is
76
.IR ignore ,
Pierangelo Masarati's avatar
Pierangelo Masarati committed
77
78
which may leave dangling references.
Other options are
79
.IR drop ,
Pierangelo Masarati's avatar
Pierangelo Masarati committed
80
81
which discards those modifications that would result in dangling
references, and
82
.IR error ,
Pierangelo Masarati's avatar
Pierangelo Masarati committed
83
84
85
86
which causes modifications that would result in dangling references
to fail.

.TP
Howard Chu's avatar
Howard Chu committed
87
.BI memberof\-dangling\-error \ <error-code>
88
If
Howard Chu's avatar
Howard Chu committed
89
.BR memberof\-dangling
90
91
92
93
94
95
96
is set to
.IR error ,
this configuration parameter can be used to modify the response code
returned in case of violation.  It defaults to "constraint violation",
but other implementations are known to return "no such object" instead.

.TP
Howard Chu's avatar
Howard Chu committed
97
.BI "memberof\-refint {" true "|" FALSE "}"
Pierangelo Masarati's avatar
Pierangelo Masarati committed
98
99
100
This option determines whether the overlay will try to preserve
referential integrity or not.
If set to
101
.IR TRUE ,
Pierangelo Masarati's avatar
Pierangelo Masarati committed
102
103
104
105
106
107
when an entry containing values of the "is member of" attribute is modified,
the corresponding groups are modified as well.

.LP
The memberof overlay may be used with any backend that provides full 
read-write functionality, but it is mainly intended for use 
108
109
110
111
with local storage backends. The maintenance operations it performs
are internal to the server on which the overlay is configured and
are never replicated. Replica servers should be configured with their
own instances of the memberOf overlay if it is desired to maintain
112
113
114
115
these memberOf attributes on the replicas.  Note that slapo-memberOf
is not compatible with syncrepl based replication, and should not be
used in a replicated environment. An alternative is to use slapo-dynlist
to emulate slapo-memberOf behavior.
Pierangelo Masarati's avatar
Pierangelo Masarati committed
116
117
118
119
120

.SH FILES
.TP
ETCDIR/slapd.conf
default slapd configuration file
121
122
123
124
125
126
127
.SH BACKWARD COMPATIBILITY
The dyngroup overlay has been reworked with the 2.5 release to use
a consistent namespace as with other overlays. As a side-effect the
following cn=config parameters are deprecated and will be removed in
a future release:
.B olcMemberOf
is replaced with olcMemberOfConfig
Pierangelo Masarati's avatar
Pierangelo Masarati committed
128
129
.SH SEE ALSO
.BR slapd.conf (5),
130
.BR slapd\-config (5),
Pierangelo Masarati's avatar
Pierangelo Masarati committed
131
132
.BR slapd (8).
The
Howard Chu's avatar
Howard Chu committed
133
.BR slapo\-memberof (5)
Pierangelo Masarati's avatar
Pierangelo Masarati committed
134
135
136
137
138
139
overlay supports dynamic configuration via
.BR back-config .
.SH ACKNOWLEDGEMENTS
.P
This module was written in 2005 by Pierangelo Masarati for SysNet s.n.c.