git.sur5r.net Git - openldap/blob - doc/man/man5/slapd-monitor.5

   1 .TH SLAPD-MONITOR 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 1998-2003 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapd-monitor \- Monitor backend to slapd
   7 .SH SYNOPSIS
   8 ETCDIR/slapd.conf
   9 .SH DESCRIPTION
  10 The monitor backend to
  11 .BR slapd (8)
  12 is not an actual database; if enabled, it is automatically generated
  13 and dynamically maintained by slapd with information about the running
  14 status of the daemon.
  15
  16 .SH CONFIGURATION
  17 These
  18 .B slapd.conf
  19 options apply to the monitor backend database.
  20 That is, they must follow a "database monitor" line and come before any
  21 subsequent "backend" or "database" lines.
  22 As opposed to most databases, the monitor database can be instantiated
  23 only once, i.e. only one occurrence of "database monitor" can occur
  24 in the
  25 .BR slapd.conf (5)
  26 file.
  27 Moreover, the suffix of the database cannot be explicitly set by means
  28 of the
  29 .B suffix
  30 directive; on the contrary, the suffix is automatically set
  31 to "\fIcn=Monitor\fP".
  32 .LP
  33 The
  34 .B monitor
  35 database honors the
  36 .B rootdn
  37 and the
  38 .B rootpw
  39 directives, and the usual ACL directives, e.g. the
  40 .B access
  41 directive.
  42 .LP
  43 The following directives can be used:
  44 .TP
  45 .B l <locality>
  46 The
  47 .B <locality>
  48 string is added to the "\fIcn=Monitor\fP" entry as value of the
  49 .B l
  50 attribute (Note: this may be subjected to changes).
  51 .LP
  52 Other database options are described in the
  53 .BR slapd.conf (5)
  54 manual page.
  55 .SH USAGE
  56 The usage is:
  57 .TP
  58 1) enable the monitor backend at configure:
  59 .LP
  60 .RS
  61 .nf
  62 configure --enable-monitor
  63 .fi
  64 .RE
  65 .TP
  66 2) activate the monitor database in the
  67 .BR slapd.conf (5)
  68 file:
  69 .LP
  70 .RS
  71 .nf
  72 database monitor
  73 .fi
  74 .RE
  75 .TP
  76 3) add ACLs as detailed in
  77 .BR slapd.access (5)
  78 to control access to the database, e.g.:
  79 .LP
  80 .RS
  81 .nf
  82 access to dn.subtree="cn=Monitor"
  83         by dn.exact="uid=Admin,dc=my,dc=org" write
  84         by users read
  85         by * none
  86 .fi
  87 .RE
  88 .TP
  89 4) ensure that the \fBcore.schema\fP file is loaded.
  90 The monitor backend relies on some standard track attributeTypes
  91 that must be already defined when the backend is started.
  92 .SH KNOWN LIMITATIONS
  93 The monitor backend does not honor size/time limits in search operations.
  94 .SH FILES
  95 .TP
  96 ETCDIR/slapd.conf
  97 default slapd configuration file
  98 .SH SEE ALSO
  99 .BR slapd.conf (5),
 100 .BR slapd.access (5),
 101 .BR slapd (8),
 102 .BR ldap (3).
 103