|
|
@@ -40,7 +40,7 @@ The script is written in python, and allows plugins. By default, the script will
|
|
|
A summary of options is included below.
|
|
|
.TP
|
|
|
.B /full/path/to/namedpipe
|
|
|
-Required - full path and file name of the named pipe. If this does not exist, it will be created. If it exists and is a named pipe, the script will use it. If it exists and is not a pipe, the script will abort. The ownership will be the same as the user running the script (or see the -u option below).
|
|
|
+Required - full path and file name of the named pipe. If this does not exist, it will be created. If it exists and is a named pipe, the script will use it. If it exists and is not a pipe, the script will abort. The ownership will be the same as the user running the script (or see the \-u option below).
|
|
|
.TP
|
|
|
.B \-m|\-\-maxlines=N
|
|
|
Number of lines to buffer - default is 1000
|
|
|
@@ -52,7 +52,7 @@ The pipe and any other files created by the script will be chown()'d to this use
|
|
|
If you want the script to exit when a particular directory server exists, specify the full path to the file containing the server pid. The default is usually something like /var/run/dirsrv/slapd-<instancename>.pid where <instancename> is usually the hostname
|
|
|
.TP
|
|
|
.B \-t|\-\-servertimeout=N
|
|
|
-Since the serverpidfile may not exist yet when the script is run, the script will wait by default 60 seconds for the pid file to exist and the server to be started. Use this option to specify a different timeout. The -t option only applies when using -s or --serverpid - otherwise it does nothing.
|
|
|
+Since the serverpidfile may not exist yet when the script is run, the script will wait by default 60 seconds for the pid file to exist and the server to be started. Use this option to specify a different timeout. The \-t option only applies when using \-s or \-\-serverpid - otherwise it does nothing.
|
|
|
.TP
|
|
|
.B \-\-serverpid=P
|
|
|
IF the server you want to track is already running, you can specify it using this argument. If the specified pid is not valid, the script will abort.
|
|
|
@@ -61,7 +61,7 @@ IF the server you want to track is already running, you can specify it using thi
|
|
|
Specify a plugin to use. The plugin must be a python file and must end in \fI.py\fR. It must specify a function called \fIplugin\fR and may specify functions called \fIpre\fR and \fIpost\fR.
|
|
|
.TP
|
|
|
.B pluginname.arg1=value ... pluginname.argN=value
|
|
|
-You can specify arguments to plugins on the command line. If there is a plugin specified as --plugin=/full/path/to/pluginname.py, the arguments for that plugin are specified as \fIpluginname.argname=value\fR. The script parses these arguments and passes them to the plugin \fIpre\fR function as a python dict. IF there is more than one argument named \fIpluginname.argname\fR the values are passed as a python list.
|
|
|
+You can specify arguments to plugins on the command line. If there is a plugin specified as \-\-plugin=/full/path/to/pluginname.py, the arguments for that plugin are specified as \fIpluginname.argname=value\fR. The script parses these arguments and passes them to the plugin \fIpre\fR function as a python dict. IF there is more than one argument named \fIpluginname.argname\fR the values are passed as a python list.
|
|
|
.SH DIRECTORY SERVER NOTES
|
|
|
The directory server will usually need to be configured to log to the named pipe instead of the usual log file. For example, use the following LDIF to tell the server to use the file \fIaccess.pipe\fR for the access log:
|
|
|
dn: cn=config
|
|
|
@@ -70,10 +70,10 @@ The directory server will usually need to be configured to log to the named pipe
|
|
|
nsslapd-accesslog-maxlogsperdir: 1
|
|
|
-
|
|
|
replace: nsslapd-accesslog-logexpirationtime
|
|
|
- nsslapd-accesslog-logexpirationtime: -1
|
|
|
+ nsslapd-accesslog-logexpirationtime: \-1
|
|
|
-
|
|
|
replace: nsslapd-accesslog-logrotationtime
|
|
|
- nsslapd-accesslog-logrotationtime: -1
|
|
|
+ nsslapd-accesslog-logrotationtime: \-1
|
|
|
-
|
|
|
replace: nsslapd-accesslog
|
|
|
nsslapd-accesslog: /var/log/dirsrv/slapd-localhost/access.pipe
|
|
|
@@ -82,7 +82,7 @@ The directory server will usually need to be configured to log to the named pipe
|
|
|
nsslapd-accesslog-logbuffering: off
|
|
|
|
|
|
NOTE: Before doing this, you should save your current configuration so you can restore it later.
|
|
|
- ldapsearch ... -s base -b "cn=config" nsslapd-accesslog-maxlogsperdir nsslapd-accesslog-logexpirationtime \
|
|
|
+ ldapsearch ... \-s base \-b "cn=config" nsslapd-accesslog-maxlogsperdir nsslapd-accesslog-logexpirationtime \
|
|
|
nsslapd-accesslog-logrotationtime nsslapd-accesslog nsslapd-accesslog > savedaccesslog.ldif
|
|
|
|
|
|
The error log and audit log have similarly named configuration attributes e.g. nsslapd-errorlog, nsslapd-auditlog. Note that the audit log is disabled by default - use nsslapd-auditlog-logging-enabled: on to enable it.
|