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