slapd-monitor.5 revision 1.4.12.1
1 .lf 1 stdin 2 .TH SLAPD-MONITOR 5 "2014/01/26" "OpenLDAP 2.4.39" 3 .\" Copyright 1998-2014 The OpenLDAP Foundation All Rights Reserved. 4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE. 5 .\" $OpenLDAP$ 6 .SH NAME 7 slapd\-monitor \- Monitor backend to slapd 8 .SH SYNOPSIS 9 /etc/openldap/slapd.conf 10 .SH DESCRIPTION 11 The 12 .B monitor 13 backend to 14 .BR slapd (8) 15 is not an actual database; if enabled, it is automatically generated 16 and dynamically maintained by 17 .B slapd 18 with information about the running status of the daemon. 19 .LP 20 To inspect all monitor information, issue a subtree search with base 21 cn=Monitor, requesting that attributes "+" and "*" are returned. 22 The monitor backend produces mostly operational attributes, and LDAP 23 only returns operational attributes that are explicitly requested. 24 Requesting attribute "+" is an extension which requests all operational 25 attributes. 26 .SH CONFIGURATION 27 These 28 .B slapd.conf 29 options apply to the 30 .B monitor 31 backend database. 32 That is, they must follow a "database monitor" line and come before any 33 subsequent "backend" or "database" lines. 34 .LP 35 As opposed to most databases, the 36 .B monitor 37 database can be instantiated only once, i.e. only one occurrence 38 of "database monitor" can occur in the 39 .BR slapd.conf (5) 40 file. 41 Moreover, the suffix of the database cannot be explicitly set by means 42 of the 43 .B suffix 44 directive. 45 The suffix is automatically set 46 to "\fIcn=Monitor\fP". 47 .LP 48 The 49 .B monitor 50 database honors the 51 .B rootdn 52 and the 53 .B rootpw 54 directives, and the usual ACL directives, e.g. the 55 .B access 56 directive. 57 .\".LP 58 .\"The following directives can be used: 59 .\".TP 60 .\".BI l \ <locality> 61 .\"The additional argument \fI<locality>\fP, 62 .\"a string, is added to the "\fIcn=Monitor\fP" entry as value of the 63 .\".B l 64 .\"attribute (Note: this may be subjected to changes). 65 .LP 66 Other database options are described in the 67 .BR slapd.conf (5) 68 manual page. 69 .SH USAGE 70 The usage is: 71 .TP 72 1) enable the \fBmonitor\fP backend at configure: 73 .LP 74 .RS 75 .nf 76 configure \-\-enable\-monitor 77 .fi 78 .RE 79 .TP 80 2) activate the \fBmonitor\fP database in the \fBslapd.conf\fP(5) file: 81 .LP 82 .RS 83 .nf 84 database monitor 85 .fi 86 .RE 87 .TP 88 3) add ACLs as detailed in \fBslapd.access\fP(5) to control access to the database, e.g.: 89 .LP 90 .RS 91 .nf 92 access to dn.subtree="cn=Monitor" 93 by dn.exact="uid=Admin,dc=my,dc=org" write 94 by users read 95 by * none 96 .fi 97 .RE 98 .TP 99 4) ensure that the \fBcore.schema\fP file is loaded. 100 The 101 .B monitor 102 backend relies on some standard track attributeTypes 103 that must be already defined when the backend is started. 104 .SH ACCESS CONTROL 105 The 106 .B monitor 107 backend honors access control semantics as indicated in 108 .BR slapd.access (5), 109 including the 110 .B disclose 111 access privilege, on all currently implemented operations. 112 .SH KNOWN LIMITATIONS 113 The 114 .B monitor 115 backend does not honor size/time limits in search operations. 116 .SH FILES 117 .TP 118 .B /etc/openldap/slapd.conf 119 default slapd configuration file 120 .SH SEE ALSO 121 .BR slapd.conf (5), 122 .BR slapd\-config (5), 123 .BR slapd.access (5), 124 .BR slapd (8), 125 .BR ldap (3). 126 .SH ACKNOWLEDGEMENTS 127 .lf 1 ./../Project 128 .\" Shared Project Acknowledgement Text 129 .B "OpenLDAP Software" 130 is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>. 131 .B "OpenLDAP Software" 132 is derived from University of Michigan LDAP 3.3 Release. 133 .lf 127 stdin 134
Indexes created Thu May 14 00:25:00 UTC 2026