1 .TH SLAPO-DYNLIST 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2006 The OpenLDAP Foundation, All Rights Reserved.
3 .\" Copying restrictions apply. See the COPYRIGHT file.
6 slapo-dynlist \- Dynamic List overlay
14 allows expansion of dynamic groups and more.
15 Any time an entry with a specific objectClass is being returned,
16 the LDAP URI-valued occurrences of a specific attribute are
17 expanded into the corresponding entries, and the values
18 of the attributes listed in the URI are added to the original
20 No recursion is allowed, to avoid potential infinite loops.
21 The resulting entry must comply with the LDAP data model, so constraints
23 For example, if a \fISINGLE-VALUE\fP attribute is listed,
24 only the first value results in the final entry.
27 The config directives that are specific to the
29 overlay must be prefixed by
31 to avoid potential conflicts with directives specific to the underlying
32 database or to other stacked overlays.
36 This directive adds the dynlist overlay to the current database,
37 or to the frontend, if used before any database instantiation; see
44 configuration option is define for the dynlist overlay. It may have multiple
45 occurrences, and it must appear after the
49 .B dynlist-attrset <group-oc> <URL-ad> [<member-ad>]
52 is the name of the objectClass that triggers the dynamic expansion of the
57 is the name of the attributeDescription that cointains the URI that is
58 expanded by the overlay; if none is present, no expansion occurs.
59 If the intersection of the attributes requested by the search operation
60 (or the asserted attribute for compares) and the attributes listed
61 in the URI is empty, no expansion occurs for that specific URI.
62 It must be a subtype of \fIlabeledURI\fP.
66 is optional; if present, the overlay behaves as a dynamic group: this
67 attribute will list the DN of the entries resulting from the internal search.
68 In this case, the <attrs> portion of the URI must be absent, and the DNs
69 of all the entries resulting from the expansion of the URI are listed
70 as values of this attribute.
71 Compares that assert the value of the
73 attribute of entries with
75 objectClass apply as if the DN of the entries resulting from the expansion
76 of the URI were present in the
78 entry as values of the
82 The dynlist overlay may be used with any backend, but it is mainly
83 intended for use with local storage backends.
84 In case the URI expansion is very resource-intensive and occurs frequently
85 with well-defined patterns, one should consider adding a proxycache
86 later on in the overlay stack.
89 This example collects all the email addresses of a database into a single
90 entry; first of all, make sure that slapd.conf contains the directives:
94 include /path/to/dyngroup.schema
101 dynlist-attrset groupOfURLs memberURL
104 and that slapd loads dynlist.la, if compiled as a run-time module;
105 then add to the database an entry like
108 dn: cn=Dynamic List,ou=Groups,dc=example,dc=com
109 objectClass: groupOfURLs
111 memberURL: ldap:///ou=People,dc=example,dc=com?mail?sub?(objectClass=person)
114 If no <attrs> are provided in the URI, all (non-operational) attributes are
117 This example implements the dynamic group feature on the
123 include /path/to/dyngroup.schema
130 dynlist-attrset groupOfURLs memberURL member
137 default slapd configuration file
142 .BR slapo-dynlist (5)
143 overlay supports dynamic configuration via
147 This module was written in 2004 by Pierangelo Masarati for SysNet s.n.c.