← Back to branch summary

~ttx/openldap/lucid-gssapi-495418

« back to all changes in this revision

Viewing changes to doc/man/man5/slapd-monitor.5

  • Committer: Bazaar Package Importer
  • Author(s): Mathias Gug
  • Date: 2008-07-10 14:45:49 UTC
  • Revision ID: james.westby@ubuntu.com-20080710144549-wck73med0e72gfyo
Tags: upstream-2.4.10
Import upstream version 2.4.10

Show diffs side-by-side

added added

removed removed

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