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 maintained by slapd with information about the running status of
  14 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 to
  31 .BR cn=Monitor .
  32
  33 No specific database directives can be specified.
  34 The
  35 .B monitor
  36 database honors the
  37 .B rootdn
  38 and the
  39 .B rootpw
  40 directives, and the usual ACL directives, e.g. the
  41 .B access
  42 directive.
  43
  44 Other database options are described in the
  45 .BR slapd.conf (5)
  46 manual page.
  47
  48 .SH USAGE
  49 The usage is:
  50 1) enable the monitor backend at configure:
  51 .LP
  52 .RS
  53 .nf
  54 configure --enable-monitor
  55 .fi
  56 .RE
  57 .LP
  58 2) activate the monitor database in the
  59 .BR slapd.conf (5)
  60 file:
  61 .LP
  62 .RS
  63 .nf
  64 database        monitor
  65 .fi
  66 .RE
  67 .LP
  68 3) add ACLs as detailed in
  69 .BR slapd.access (5)
  70 to control access to the database:
  71 .LP
  72 .RS
  73 .nf
  74 access to dn.subtree="cn=Monitor"
  75         by dn.exact="uid=Admin,dc=my,dc=org" write
  76         by users read
  77         by * none
  78 .fi
  79 .RE
  80 .LP
  81 .SH FILES
  82 .TP
  83 ETCDIR/slapd.conf
  84 default slapd configuration file
  85 .SH SEE ALSO
  86 .BR slapd.conf (5),
  87 .BR slapd.access (5),
  88 .BR slapd (8),
  89 .BR ldap (3).
  90